InitializeAutoShowListTask - - Alibaba Cloud Documentation Center

Creates a scheduled task.

Operation description

This operation creates a scheduled task to start and stop a playlist. When you call this operation, you must specify the required parameters.

QPS limit

This operation is limited to 10 queries per second (QPS) per user. Calls that exceed this limit are throttled. Throttling can affect your business. Plan your calls accordingly.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:InitializeAutoShowListTask

get

*Caster

acs:live:*:{#accountId}:caster/{#CasterId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
ResourceIds	string	No	A list of video-on-demand (VOD) media asset IDs in the playlist. Currently, only MP4 files from the VOD platform are supported. A maximum of three programs are supported. The programs are played in the order they appear in the list and automatically stop at the specified EndTime. Note Get the video file ID from the console or from the parameters returned by an API operation. For more information, see Media management or Obtain upload URLs and credentials for audio and video.	["89e02xxxxfb349axxxxa0c350d** ","6ae0xxxxxb349axxxxa0c350a**"]
StartTime	integer	Yes	The start timestamp. Unit: milliseconds.	1645688994000
EndTime	integer	Yes	The end timestamp. Unit: milliseconds.	1645688994000
CasterConfig	string	Yes	The production studio configuration. It includes: (Required) CasterTemplate: The output resolution of the production studio. (Optional) LiveTemplate: The list of output transcoding jobs. Note This parameter is a JSON-formatted string. The fields in the struct must be in UpperCamelCase.	{"CasterTemplate": "lp_ld","LiveTemplates":["lhd", "lsd","lud"]}
DomainName	string	Yes	The output streaming domain.	example.aliyundoc.com
CallBackUrl	string	No	The user webhook address.	http://***.com/callback

Response elements

Element	Type	Description	Example
	object
CasterId	string	The ID of the production studio. Note Use this ID as a request parameter to query the streaming URL, start the production studio, add video resources, add layouts, query layouts, add components, and add playlists.	b4810848-bcf9-4aef-bd4a-e6bba2d9****
RequestId	string	The request ID.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
StreamList	string	A list of output URLs for the production studio. videoFormat: The format of the streaming URL. outputStreamUrl: The stream pulling URL. transcodeConfig: The description of the transcoding resolution for the stream pulling URL.	[{"videoFormat":"flv","outputStreamUrl":"http://example.aliyundoc.com","transcodeConfig":"original"}]

Examples

Success response

JSON format

{
  "CasterId": "b4810848-bcf9-4aef-bd4a-e6bba2d9****",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  "StreamList": "[{\"videoFormat\":\"flv\",\"outputStreamUrl\":\"http://example.aliyundoc.com\",\"transcodeConfig\":\"original\"}]"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.PurchaseTime	%s, please check and try again later.	The parameter PurchaseTime is invalid, please check and try again.
400	InvalidParameter.ExpireTime	%s, please check and try again later.	The parameter ExpireTime is invalid, please check and try again.
400	MissingParameter	%s.	Missing parameter
400	InvalidChargeType.Malformed	%s, please check and try again later.	The parameter ChargeType is invalid, please check and try again.
400	InvalidChargeType.PostSupport	%s, please check and try again later.	ChargeType only supports post-paid, please check and try again.
400	InvalidCasterTemplate.Malformed	%s, please check and try again later.	The parameter CasterTemplate is invalid, please check and try again.
400	InvalidParameter.Malformed	There are invalid parameters: %s.	There are invalid parameters: %s.
400	InvalidParameter.ChargeType	%s, please check and try again later.	The parameter ChargeType is invalid, please check and try again.
400	InvalidPeriod.Malformed	%s, please check and try again later.	Invalid time interval, please check and try again.
400	InvalidClientToken.Malformed	%s, please check and try again later.	The parameter ClientToken is invalid, please check and try again.
400	IncorrectCasterStatus	%s, please check and try again later.	Guide station status error, please check and try again.
400	InvalidCasterId.Malformed	%s, please check and try again later.	The parameter CasterId is invalid, please check and try again.
400	InvalidUserId.Malformed	%s, please check userId.	The userId passed in is invalid, please check.
400	InvalidParameter.StartTime	%s, please check and try again later.	The parameter StartTime is invalid, please check and try again.
401	CasterNumberExceed	%s, please check and try again later.	The number of casters exceeds the limit. Please check and try again.
401	IllegalOperation	%s, please check and try again later.	Operation not allowed, please check and try again.
500	InternalError	%s, please try again later.	Internal error, please try again later.
404	IncorrectCasterStatus.EnableChannel	%s, please check and try again later.	Caster status does not support EnableChannel settings, please check and try again.
404	InvalidParameter.NormType	%s, please check and try again later.	The parameter NormType is invalid, please check and try again.
404	InvalidConfiguration.NotFound	%s, please check and try again later.	Configuration does not exist, please check and try again.
404	InvalidCaster.NotFound	%s, please check and try again later.	The guide station does not exist, please check and try again.
404	InvalidDomainName.NotFound	%s, please check and try again later.	Domain name does not exist, please check and try again.
408	CreateCaster.Timeout	%s, please try again later.	Call CreateCaster timed out, please try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.