DescribeCasterChannels - ApsaraVideo Live - Alibaba Cloud Documentation Center

Usage notes

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

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

DescribeCasterChannels

The operation that you want to perform. Set the value to DescribeCasterChannels.

CasterId

String

Yes

a2b8e671-2fe5-4642-a2ec-bf93880e****

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 Name column.

Response parameters

Parameter	Type	Example	Description
Channels	Array of Channel		The channels.
Channel
ChannelId	String	RV01	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.
FaceBeauty	String	0	The face retouching effect. Valid values: 0 (all effects), 1 (skin smoothing), 2 (skin whitening), 3 (dark circles removal), and 4 (nasolabial folds removal).
ResourceId	String	87642866-281E-4AEA-9582-B124879****	The ID of the video resource.
RtmpUrl	String	rtmp://demo.aliyundoc.com/caster/rtmperf?auth_key=****	The URL in the Real-Time Messaging Protocol (RTMP) format.
StreamUrl	String	http://demo.aliyundoc.com/caster/streamwsx.flv?auth_key=YYYYY	The URL of the output content in the channel.
RequestId	String	83C52866-281E-4AEA-9582-B1245406349D	The request ID.
Total	Integer	1	The total number of channels returned.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeCasterChannels
&CasterId=a2b8e671-2fe5-4642-a2ec-bf93880e****
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeCasterChannelsResponse>
    <Channels>
        <ChannelId>RV01</ChannelId>
        <FaceBeauty>0</FaceBeauty>
        <ResourceId>87642866-281E-4AEA-9582-B124879****</ResourceId>
        <RtmpUrl>rtmp://demo.aliyundoc.com/caster/rtmperf?auth_key=****</RtmpUrl>
        <StreamUrl>http://demo.aliyundoc.com/caster/streamwsx.flv?auth_key=YYYYY</StreamUrl>
    </Channels>
    <RequestId>83C52866-281E-4AEA-9582-B1245406349D</RequestId>
    <Total>1</Total>
</DescribeCasterChannelsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Channels" : [ {
    "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-B1245406349D",
  "Total" : 1
}

Error codes

For a list of error codes, see Service error codes.