DescribeCasterChannels - 查询导播台通道信息列表

查询导播台通道。

接口说明

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

QPS 限制

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

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

live:DescribeCasterChannels

get

*Caster

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

请求参数

名称

类型

必填

描述

示例值

RegionId

string

地域 ID。

cn-shanghai

CasterId

string

导播台 ID。

  • 如果您通过 CreateCaster 接口创建导播台,请查看 CreateCaster 接口调用返回的参数 CasterId 值。

  • 如果您通过直播控制台创建导播台,请通过直播控制台 > 导播台 > 云导播台页面查看。

说明

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

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

返回参数

名称

类型

描述

示例值

object

Channels

object

Channel

array<object>

通道列表。

object

通道列表。

ChannelId

string

通道位置 ID。

布局应用通道 ID,每个位置至多设置一个视频源,格式需符合“RV01~RV12”。

RV01

FaceBeauty

string

人脸美颜。具体包括:0(whole)、1(磨皮)、2(美白)、3(去除黑眼圈)、4(法令纹)。

0

ResourceId

string

视频源 Id。

87642866-281E-4AEA-9582-B124879****

RtmpUrl

string

rtmp 地址。

rtmp://demo.aliyundoc.com/caster/rtmperf?auth_key=****

StreamUrl

string

通道输出地址。

http://demo.aliyundoc.com/caster/streamwsx.flv?auth_key=YYYYY

RequestId

string

请求 ID。

83C52866-281E-4AEA-9582-B124********

Total

integer

总数量。

1

示例

正常返回示例

JSON格式

{
  "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
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParameter.Malformed %s
401 IllegalOperation %s
500 InternalError %s
404 InvalidDomainName.NotFound %s
404 InvalidCaster.NotFound %s

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

变更历史

更多信息,参考变更详情