Queries the information about an episode list in a production studio.
Usage note
This operation is only applicable to the production studio whose NormType is set to 0 (the playlist mode) when you call the CreateCaster operation.
QPS limit
A single user can perform a maximum of 4 queries per second (QPS). Throttling is triggered when the number of calls per second exceeds the QPS limit. The throttling may affect your business. Thus, we recommend that you observe the QPS limit on this operation. For more information about what a single user means and the QPS details, see QPS limit on an API operation in ApsaraVideo Live.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeCasterProgram |
The operation that you want to perform. Set the value to DescribeCasterProgram. |
CasterId | String | Yes | 3463f576-ff9e-4807-be32-b95d5bad**** |
The ID of the production studio. It is included in the response when you call the CreateCaster operation. |
RegionId | String | No | cn-shanghai |
The ID of the region. |
EpisodeId | String | No | 1872639A-F203-4EC5-8E43-CB92E68F**** |
The ID of the episode. |
EpisodeType | String | No | Resource |
The type of the episode. Valid values:
|
StartTime | String | No | 2016-06-29T09:00:00Z |
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. |
EndTime | String | No | 2016-06-29T10:00:00Z |
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. |
PageNum | Integer | No | 5 |
The number of the page to return. |
PageSize | Integer | No | 10 |
The number of entries to return on each page. |
Status | Integer | No | 0 |
The status of the episode. Valid values:
|
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
CasterId | String | 3463f576-ff9e-4807-be32-b95d5bad**** |
The ID of the production studio. |
Episodes | Array of Episode |
The information about the episodes that were queried. |
|
Episode | |||
ComponentIds | List | ["1872639A-F203-4EC5-8E43-CB929282****" ] |
The information about the components that were queried. |
EndTime | String | 2016-06-29T10:02:00Z |
The end of the time range in which data was queried. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. |
EpisodeId | String | 1872639A-F203-4EC5-8E43-CB92E68F**** |
The ID of the episode. |
EpisodeName | String | program_name_1 |
The name of the episode. |
EpisodeType | String | Resource |
The type of the episode. Valid values:
|
ResourceId | String | 1872639A-F203-4EC5-8E43-CB92E837**** |
The ID of the video resource. |
StartTime | String | 2016-06-29T09:00:00Z |
The beginning of the time range in which data was queried. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. |
Status | Integer | 0 |
The status of the episode. |
SwitchType | String | TimeFirst |
The policy for switching episodes. Valid values:
|
ProgramEffect | Integer | 1 |
Indicates whether the carousel playback is enabled.
|
ProgramName | String | programs_name |
The name of the episode list for carousel playback. |
RequestId | String | 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8 |
The ID of the request. |
Total | Integer | 1 |
The total number of episodes that were returned. |
Examples
Sample requests
https://live.aliyuncs.com/?Action=DescribeCasterProgram
&CasterId=3463f576-ff9e-4807-be32-b95d5bad****
&<Common request parameters>
Sample success responses
XML
format
<DescribeCasterProgramResponse>
<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
<ProgramId>1872639A-F203-4EC5-8E43-CB92E68F****</ProgramId>
<ProgramName>programs_name</ProgramName>
<ProgramEffect>1</ProgramEffect>
<Episodes>
<EpisodeId>1872639A-F203-4EC5-8E43-CB92E68F****</EpisodeId>
<EpisodeType>Resource</EpisodeType>
<EpisodeName>program_name_1</EpisodeName>
<ResourceId>1872639A-F203-4EC5-8E43-CB92E837****</ResourceId>
<ComponentIds>1872639A-F203-4EC5-8E43-CB929282****</ComponentIds>
<StartTime>2016-06-29T09:00:00Z</StartTime>
<EndTime>2016-06-29T10:02:00Z</EndTime>
<Duration>120</Duration>
<SwitchType>TimeFirst</SwitchType>
</Episodes>
<Episodes>
<EpisodeId>1872639A-F203-4EC5-8E43-CB92E687****</EpisodeId>
<EpisodeType>Component</EpisodeType>
<ComponentIds>1872639A-F203-4EC5-8E43-CB625364****</ComponentIds>
<StartTime>2016-06-29T19:02:00Z</StartTime>
<EndTime>2016-06-29T19:04:00Z</EndTime>
</Episodes>
</DescribeCasterProgramResponse>
JSON
format
{
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
"ProgramId": "1872639A-F203-4EC5-8E43-CB92E68F****",
"ProgramName": "programs_name",
"ProgramEffect":1,
"Episodes": [
{
"EpisodeId": "1872639A-F203-4EC5-8E43-CB92E68F****",
"EpisodeType": "Resource",
"EpisodeName": "program_name_1",
"ResourceId": "1872639A-F203-4EC5-8E43-CB92E837****",
"ComponentIds": [
"1872639A-F203-4EC5-8E43-CB929282****"
],
"StartTime": "2016-06-29T09:00:00Z",
"EndTime": "2016-06-29T10:02:00Z",
"Duration": 120,
"SwitchType": "TimeFirst"
},
{
"EpisodeId": "1872639A-F203-4EC5-8E43-CB92E687****",
"EpisodeType": "Component",
"ComponentIds": [
"1872639A-F203-4EC5-8E43-CB625364****"
],
"StartTime": "2016-06-29T19:02:00Z",
"EndTime": "2016-06-29T19:04:00Z"
}
]
}
Error codes
For a list of error codes, visit the API Error Center.