Adds an episode to a production studio.
Operation description
To call this operation, you must obtain the production studio ID in advance. The production studio ID is generated after the production studio is created.
- If the production studio was created by calling the CreateCaster operation, check the value of the response parameter CasterId to obtain the ID.
- If the production studio was created by using the ApsaraVideo Live console, obtain the ID on the Production Studio Management page. To go to the page, log on to the ApsaraVideo Live console and click Production Studios in the left-side navigation pane.
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. For more information, see QPS limits.
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:AddCasterEpisode | create | *Caster acs:live:*:{#accountId}:caster/{#CasterId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ComponentId | array | No | The components. Components in the production studio are listed from the bottom to the top in an array. If a component was added by calling the AddCasterComponent operation, check the value of the response parameter ComponentId to obtain the component ID.
Note
The variable N specifies the sequence number of the component. For example, ComponentId.1 specifies the ID of the first component and ComponentId.2 specifies the ID of the second component.
| |
| string | No | The ID of the component. | 21926b36-7dd2-4fde-ae25-51b5bc8e**** | |
| CasterId | string | Yes | The ID of the production studio. If you create a production studio through the CreateCaster interface, check the value of the CasterId parameter in the response. If you create a production studio through the ApsaraVideo Live Console, log in to the console, then check the ID of the production studio through the following path: Production Studios > Production Studio Management Note
The CasterId is reflected in the Name column on the Production Studio Management page.
| LIVEPRODUCER_POST-cn-0pp1czt**** |
| EpisodeType | string | Yes | The type of the episode. Valid values:
| Resource |
| EpisodeName | string | No | The name of the episode. | episode_1 |
| ResourceId | string | No | The ID of the video resource. It is included in the response when you call the AddCasterVideoResource operation. This parameter takes effect and is required only when the EpisodeType parameter is set to Resource. | a2b8e671-2fe5-4642-a2ec-bf93880e**** |
| StartTime | string | Yes | The time when the episode starts. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. | 2016-06-29T08:00:00Z |
| EndTime | string | Yes | The time when the episode ends. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. | 2016-06-29T09:10:00Z |
| SwitchType | string | Yes | The policy for switching episodes. Valid values:
This parameter takes effect only when the EpisodeType parameter is set to Resource. Note
This parameter must be set to TimeFirst when the video resource is a live stream.
| TimeFirst |
Response parameters
Examples
Sample success responses
JSONformat
{
"EpisodeId": "21926b36-7dd2-4fde-ae25-51b5bc8e****",
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F****"
}Error codes
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | MissingParameter | %s |
| 400 | InvalidParameter.Malformed | %s |
| 400 | SwitchTypeInvalid.Malformed | %s |
| 400 | IncorrectStartTime | %s |
| 400 | IncorrectEndTime | %s |
| 400 | EpisodeConflict.Malformed | %s |
| 400 | InvalidCasterId.Malformed | %s |
| 401 | IllegalOperation | %s |
| 404 | InvalidCaster.NotFound | %s |
| 404 | InvalidResource.NotFound | %s |
| 404 | InvalidComponent.NotFound | %s |
| 500 | InternalError | %s |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|