Queries the channels of a production studio.
Usage note
The CasterId parameter is required in the request.
QPS limit
A single user can perform a maximum of 15 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
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 you create a production studio through the CreateCaster interface, check the value of the CasterId parameter in the response. If you create a production studio through the ApsaraVideo Live Console, log in to the console, then check the ID of the production studio through the following path: Production Studios > Production Studio Management Note The CasterId is reflected in the Name column on the Production Studio Management page.
|
RegionId | String | No | cn-shanghai |
The ID of the region. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Channels | Array of Channel |
The channels that were queried. |
|
Channel | |||
ChannelId | String | RV01 |
The ID of the channel. The layout references the channel IDs when the channels are enabled. You can specify up to one video resource for a channel. The value of this parameter must be in the RV[Number] format, such as RV01 and RV12. |
ResourceId | String | 87642866-281E-4AEA-9582-B124879**** |
The ID of the video resource. |
RtmpUrl | String | rtmp://demo.aliyundoc.com/caster/rtmperf?auth_key=**** |
The Real Time Messaging Protocol (RTMP) URL. |
StreamUrl | String | http://demo.aliyundoc.com/caster/streamwsx.flv?auth_key=YYYYY |
The URL of the output channel of the production studio. |
RequestId | String | 83C52866-281E-4AEA-9582-B1245406349D |
The ID of the request. |
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
<DescribeCasterChannelsResponse>
<RequestId>3be7ade8-d907-483c-b24a-0dad4595beaf</RequestId>
<Channels>
<ResourceId>f66bfd3e-a4f3-4d37-ad72-5206cf15****</ResourceId>
<ChannelId>RV01</ChannelId>
<StreamUrl>http://demo.aliyundoc.com/caster/streamwsx.flv?auth_key=YYYYY</StreamUrl>
<RtmpUrl>rtmp://demo.aliyundoc.com/caster/rtmperf?auth_key=****</RtmpUrl>
</Channels>
</DescribeCasterChannelsResponse>
JSON
format
{
"RequestId": "3be7ade8-d907-483c-b24a-0dad4595beaf",
"Channels": [
{
"ResourceId": "f66bfd3e-a4f3-4d37-ad72-5206cf15****",
"ChannelId": "RV01",
"StreamUrl": "http://demo.aliyundoc.com/caster/streamwsx.flv?auth_key=****",
"RtmpUrl": "rtmp://demo.aliyundoc.com/caster/rtmperf?auth_key=****"
}
]
}
Error codes
For a list of error codes, visit the API Error Center.