Adds an episode list to a production studio.
Operation description
You need to create a production studio and obtain the production studio configurations before you call this operation to create an episode list in the production studio. For information about how to create a production studio, see CreateCaster .
QPS limit
You can call this operation up to 4 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| live:AddCasterEpisodeGroup | create | *Domain acs:live:*:{#accountId}:domain/{#DomainName} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Item | array<object> | Yes | The list of episodes. | |
| object | Yes | The information about the episode. | ||
| ItemName | string | No | The name of the episode. | episode1 |
| VodUrl | string | No | The URL of the VOD file. If you query the input sources of the production studio by calling the DescribeCasterVideoResources operation, check the value of the response parameter VodUrl to obtain the URL. Note
This parameter takes effect only when the input source is a video file that is not from the media library. The video file can be in the MP4, FLV, or TS format. | http://learn.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****.flv?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f**** |
| ClientToken | string | Yes | The client token that is used to ensure the idempotence of the request. You can use the client to generate a token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. | 8751ad99-2ddb-4aac-ad44-84b21102**** |
| DomainName | string | Yes | The main streaming domain. | example.com |
| StartTime | string | Yes | The time when the episode list starts to play. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. | 2018-03-06T19:00:00Z |
| RepeatNum | integer | Yes | The number of times the episode list repeats after the first playback is complete. Valid values:
| 0 |
| SideOutputUrl | string | Yes | The custom standby URL. If this parameter is empty, the ingest address corresponding to the output address automatically generated by Alibaba Cloud will be used by default. | rtmp://guide.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f**** |
| CallbackUrl | string | Yes | The callback URL. If you query the configurations of the production studio by calling the DescribeCasterConfig operation, check the value of the response parameter CallbackUrl to obtain the URL. | http://developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201****?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"ItemIds": {
"ItemId": [
"21926b36-7dd2-4fde-ae25-51b5bc8e****"
]
},
"ProgramId": "16A96B9A-F203-4EC5-8E43-CB92E68X****",
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F****"
}Error codes
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | MissingParameter | %s |
| 400 | InvalidParameter.Malformed | %s |
| 400 | IncorrectStartTime | %s |
| 401 | IllegalOperation | %s |
| 500 | InternalError | %s |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|