DescribeCasterProgram - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the program list of a production studio.

Operation description

You can call this operation to query the program list of a production studio. This operation supports video source and component nodes.

QPS limits

The queries per second (QPS) limit for a single user is 4 calls per second. If the limit is exceeded, API calls are throttled. This may affect your business. Plan your calls accordingly.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:DescribeCasterProgram

get

*Caster

acs:live:*:{#accountId}:caster/{#CasterId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region.	cn-shanghai
CasterId	string	Yes	The ID of the production studio. If you create a production studio by calling the CreateCaster operation, use the CasterId value that is returned in the response. If you create a production studio in the LIVE console, find the ID on the Cloud Production Studio page. To go to this page, choose LIVE > Production Studio > Cloud Production Studio. Note The name of the production studio in the list on the Cloud Production Studio page is its ID.	LIVEPRODUCER_POST-cn-0pp1czt****
EpisodeId	string	No	The ID of the program.	1872639A-F203-4EC5-8E43-CB92E68F****
EpisodeType	string	No	The type of the node. Valid values: Resource: video source. Component: component.	Resource
StartTime	string	No	The start time. The time must be in the yyyy-MM-ddTHH:mm:ssZ format and in UTC.	2016-06-29T09:00:00Z
EndTime	string	No	The end time. The time must be in the yyyy-MM-ddTHH:mm:ssZ format and in UTC.	2016-06-29T10:00:00Z
PageNum	integer	No	The page number.	5
PageSize	integer	No	The number of programs on each page.	10
Status	integer	No	The status of the program. Valid values: 0: not started 1: playing 2: finished	0

Response parameters

Parameter	Type	Description	Example
	object
CasterId	string	The ID of the production studio.	LIVEPRODUCER_POST-cn-0pp1czt****
Episodes	object
Episode	array<object>	The nodes.
	object	A node.
ComponentIds	object
ComponentId	array	The component IDs.
	string	A component ID.	["1872639A-F203-4EC5-8E43-CB929282****" ]
EndTime	string	The end time. The time is in the yyyy-MM-ddTHH:mm:ssZ format and in UTC.	2016-06-29T10:02:00Z
EpisodeId	string	The ID of the program.	1872639A-F203-4EC5-8E43-CB92E68F****
EpisodeName	string	The name of the program.	program_name_1
EpisodeType	string	The type of the node. Valid values: Resource: video source. Component: component.	Resource
ResourceId	string	The ID of the video source.	1872639A-F203-4EC5-8E43-CB92E837****
StartTime	string	The start time. The time is in the yyyy-MM-ddTHH:mm:ssZ format and in UTC.	2016-06-29T09:00:00Z
Status	integer	The status of the program.	0
SwitchType	string	The switch policy. Valid values: TimeFirst: time-priority. Live programs can use only this policy. ContentFirst: content-priority.	TimeFirst
ProgramEffect	integer	Indicates whether the program list is enabled. 0: disabled 1: enabled	1
ProgramName	string	The name of the program list.	programs_name
RequestId	string	The request ID.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
Total	integer	The total number of entries returned.	1

Examples

Success response

JSON format

{
  "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
500	InternalError	%s
404	InvalidCaster.NotFound	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.