DescribeCasterChannels - - Alibaba Cloud Documentation Center

Operation description

After you create a production studio by calling the CreateCaster operation, you can call this operation to query its channels.

QPS limit

This operation is limited to 15 queries per second (QPS) for each user. If you exceed this limit, API calls are throttled, which can affect your business. We recommend that you call this operation at a reasonable rate.

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:DescribeCasterChannels

get

*Caster

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
CasterId	string	Yes	The ID of the production studio. If you call the CreateCaster operation to create a production studio, use the CasterId returned in the response. If you create a production studio in the ApsaraVideo Live console, go to the ApsaraVideo Live console > Production Studio > Cloud Production Studio page to view the ID. Note The name of a production studio in the list on the Cloud Production Studio page is the ID of the production studio.	a2b8e671-2fe5-4642-a2ec-bf93880e****

Response elements

Element	Type	Description	Example
	object
Channels	object
Channel	array<object>	The list of channels.
	object	The list of channels.
ChannelId	string	The ID of the channel slot used in the layout. You can set a maximum of one video source for each slot. The ID must be in the format of RV01 to RV12. The ID of the channel that is used in the layout. You can set a maximum of one video source for each slot. The ID must be in the format of RV01 to RV12.	RV01
FaceBeauty	string	The retouching settings. Valid values: 0 (whole), 1 (skin smoothing), 2 (skin whitening), 3 (dark circle removal), and 4 (nasolabial fold removal).	0
ResourceId	string	The ID of the video source.	87642866-281E-4AEA-9582-B124879****
RtmpUrl	string	The RTMP URL.	rtmp://demo.aliyundoc.com/caster/rtmperf?auth_key=****
StreamUrl	string	The output URL of 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 entries.	1

Examples

Success response

JSON format

{
  "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	Description
400	InvalidParameter.Malformed	There are invalid parameters: %s.	There are invalid parameters: %s.
401	IllegalOperation	%s, please check and try again later.	Operation not allowed, please check and try again.
500	InternalError	%s, please try again later.	Internal error, please try again later.
404	InvalidDomainName.NotFound	%s, please check and try again later.	Domain name does not exist, please check and try again.
404	InvalidCaster.NotFound	%s, please check and try again later.	The guide station does not exist, please check and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.