DescribeCasterProgram - ApsaraVideo Live - Alibaba Cloud Documentation Center

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

Operation description

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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 Resources is 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	none

Request parameters

Parameter	Type	Required	Description	Example
CasterId	string	Yes	The ID of the production studio. It is included in the response when you call the CreateCaster operation.	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: a video resource. Component: a component.	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 number of the page to return.	5
PageSize	integer	No	The number of entries to return on each page.	10
Status	integer	No	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.	0

Response parameters

Parameter	Type	Description	Example
	object
CasterId	string	The ID of the production studio.	LIVEPRODUCER_POST-cn-0pp1czt****
Episodes	array<object>	The information about the episodes that were queried.
Episode	object	Node list.
ComponentIds	array	The information about the components that were queried.
ComponentId	string	Component list.	["1872639A-F203-4EC5-8E43-CB929282****" ]
EndTime	string	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.	2016-06-29T10:02:00Z
EpisodeId	string	The ID of the episode.	1872639A-F203-4EC5-8E43-CB92E68F****
EpisodeName	string	The name of the episode.	program_name_1
EpisodeType	string	The type of the episode. Valid values: Resource: a video resource. Component: a component.	Resource
ResourceId	string	The ID of the video resource.	1872639A-F203-4EC5-8E43-CB92E837****
StartTime	string	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.	2016-06-29T09:00:00Z
Status	integer	The status of the episode.	0
SwitchType	string	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.	TimeFirst
ProgramEffect	integer	Indicates whether the carousel playback is enabled. 0: The carousel playback is disabled. 1: The carousel playback is enabled.	1
ProgramName	string	The name of the episode list for carousel playback.	programs_name
RequestId	string	The ID of the request.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
Total	integer	The total number of episodes that were returned.	1

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

No change history