DescribeCasterChannels - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the channels of a production studio.

Operation description

You can call the CreateCaster operation to create a production studio and then call this operation to query the channels of the production studio.

QPS limit

You can call this operation up to 15 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. For more information, see QPS limits.

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:DescribeCasterChannels	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. If the production studio was created by calling the CreateCaster operation, check the value of the response parameter CasterId to obtain the ID. If the production studio was created by using the ApsaraVideo Live console, obtain the ID on the Production Studio Management page. To go to the page, log on to the ApsaraVideo Live console and click Production Studios in the left-side navigation pane. Note You can find the ID of the production studio in the Instance ID/Name column.	a2b8e671-2fe5-4642-a2ec-bf93880e****

Response parameters

Parameter	Type	Description	Example
	object
Channels	array<object>	The channels.
Channel	object	The information about the channel.
ChannelId	string	The ID of the channel. The layout references the channel ID when the channel is enabled. You can specify up to one video resource for the channel. The value of this parameter must be in the RV[Number] format, such as RV01 and RV12.	RV01
FaceBeauty	string	The face retouching effect. Valid values: 0 (all effects), 1 (skin smoothing), 2 (skin whitening), 3 (dark circles removal), and 4 (nasolabial folds removal).	0
ResourceId	string	The ID of the video resource.	87642866-281E-4AEA-9582-B124879****
RtmpUrl	string	The URL in the Real-Time Messaging Protocol (RTMP) format.	rtmp://demo.aliyundoc.com/caster/rtmperf?auth_key=****
StreamUrl	string	The URL of the output content in the channel.	http://demo.aliyundoc.com/caster/streamwsx.flv?auth_key=YYYYY
RequestId	string	The request ID.	83C52866-281E-4AEA-9582-B124********
Total	integer	The total number of channels.	1

Examples

Sample success responses

JSONformat

{
  "Channels": {
    "Channel": [
      {
        "ChannelId": "RV01",
        "FaceBeauty": "0",
        "ResourceId": "87642866-281E-4AEA-9582-B124879****",
        "RtmpUrl": "rtmp://demo.aliyundoc.com/caster/rtmperf?auth_key=****",
        "StreamUrl": "http://demo.aliyundoc.com/caster/streamwsx.flv?auth_key=YYYYY"
      }
    ]
  },
  "RequestId": "83C52866-281E-4AEA-9582-B124********",
  "Total": 1
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParameter.Malformed	%s
401	IllegalOperation	%s
404	InvalidDomainName.NotFound	%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