Queries the information about an episode list in a production studio.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

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 LIVEPRODUCER_POST-cn-0pp1czt****

The ID of the production studio.

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:

  • Resource: a video resource.
  • Component: a component.
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:

  • 0: The episode has not been played.
  • 1: The episode is being played.
  • 2: The episode has been played.

Response parameters

Parameter Type Example Description
CasterId String LIVEPRODUCER_POST-cn-0pp1czt****

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:

  • Resource: a video resource.
  • Component: a component.
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:

  • TimeFirst: The episode starts when the preceding episode ends and ends when the next episode starts. If no next episode exists, the episode keeps repeating until a new episode is added or the production studio stops. This parameter must be set to TimeFirst when the video resource is a live stream.
  • ContentFirst: The episode starts and ends as scheduled.
ProgramEffect Integer 1

Indicates whether the carousel playback is enabled.

  • 0: The carousel playback is disabled.
  • 1: 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=LIVEPRODUCER_POST-cn-0pp1czt****
&<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.