调用DescribeCasterChannels查询导播台通道_视频直播(LIVE)-阿里云帮助中心

使用说明

先通过CreateCaster接口创建导播台，再调用本接口查询导播台通道。

QPS限制

本接口的单用户QPS限制为15次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见QPS限制。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称

类型

是否必选

示例值

描述

Action

String

是

DescribeCasterChannels

系统规定参数。取值：DescribeCasterChannels。

CasterId

String

是

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

导播台ID。

如果您通过CreateCaster接口创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。
如果您通过直播控制台创建导播台，请通过直播控制台 > 导播台 > 云导播台页面查看。

说明直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。

返回数据

名称	类型	示例值	描述
Channels	Array of Channel		通道列表。
Channel
ChannelId	String	RV01	通道位置ID。布局应用通道ID，每个位置至多设置一个视频源，格式需符合“RV01~RV12”。
FaceBeauty	String	0	人脸美颜。具体包括：0（whole）、1（磨皮）、2（美白）、3（去除黑眼圈）、4（法令纹）。
ResourceId	String	87642866-281E-4AEA-9582-B124879****	视频源Id。
RtmpUrl	String	rtmp://demo.aliyundoc.com/caster/rtmperf?auth_key=****	rtmp地址。
StreamUrl	String	http://demo.aliyundoc.com/caster/streamwsx.flv?auth_key=YYYYY	通道输出地址。
RequestId	String	83C52866-281E-4AEA-9582-B1245406349D	请求ID。
Total	Integer	1	总数量。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=DescribeCasterChannels
&CasterId=a2b8e671-2fe5-4642-a2ec-bf93880e****
&<公共请求参数>

正常返回示例

XML格式

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格式

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
}

错误码

访问错误中心查看更多错误码。