Queries the information about the episode list for carousel playback in a production studio.
Operation description
You can call this operation to query episodes in the episode list for carousel playback. The supported types of episodes include video resource and component.
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:DescribeCasterProgram | get | *Caster acs:live:*:{#accountId}:caster/{#CasterId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| CasterId | string | Yes | The ID of the production studio.
Note
You can find the ID of the production studio in the Instance ID/Name column.
| LIVEPRODUCER_POST-cn-0pp1czt**** |
| EpisodeId | string | No | The ID of the episode. | 1872639A-F203-4EC5-8E43-CB92E68F**** |
| EpisodeType | string | No | The type of the episode. Valid values:
| Resource |
| StartTime | string | No | The beginning of the time range to query. 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:00:00Z |
| EndTime | string | No | The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. | 2016-06-29T10:00:00Z |
| PageNum | integer | No | The page number. | 5 |
| PageSize | integer | No | The number of entries per page. | 10 |
| Status | integer | No | The status of the episode. Valid values:
| 0 |
Response parameters
Examples
Sample success responses
JSONformat
{
"CasterId": "LIVEPRODUCER_POST-cn-0pp1czt****",
"Episodes": {
"Episode": [
{
"ComponentIds": {
"ComponentId": [
"[\"1872639A-F203-4EC5-8E43-CB929282****\" ]"
]
},
"EndTime": "2016-06-29T10:02:00Z",
"EpisodeId": "1872639A-F203-4EC5-8E43-CB92E68F****",
"EpisodeName": "program_name_1",
"EpisodeType": "Resource",
"ResourceId": "1872639A-F203-4EC5-8E43-CB92E837****",
"StartTime": "2016-06-29T09:00:00Z",
"Status": 0,
"SwitchType": "TimeFirst"
}
]
},
"ProgramEffect": 1,
"ProgramName": "programs_name",
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
"Total": 1
}Error codes
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | InvalidPageSize.Malformed | %s |
| 400 | InvalidPageNum.Malformed | %s |
| 400 | InvalidStartTime.Malformed | %s |
| 400 | InvalidEndTime.Malformed | %s |
| 400 | InvalidStatus.Malformed | %s |
| 400 | InvalidParameter.Malformed | %s |
| 400 | InvalidCasterId.Malformed | %s |
| 404 | InvalidCaster.NotFound | %s |
| 500 | InternalError | %s |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|