DescribeCasters_视频直播_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

先通过 CreateCaste 接口创建导播台,再调用本接口查询导播台列表。导播台的状态分为空闲和导播中 。

QPS 限制

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

流控信息

请求速率为15/1(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
live:DescribeCasters
Get
Caster
acs:live:*:{#accountId}:caster/{#CasterId}

请求参数

字段名称字段详情
CasterIdstring

导播台 ID。展开详情

示例值:LIVEPRODUCER_POST-cn-0pp1czt****参考取值来源:
    CopyCaster
    AddCasterLayout
    CreateCaster
    SetCasterConfig
    ModifyCasterEpisode
CasterNamestring

导播台名称。

示例值:liveCaster****参考取值来源:
    DescribeCasterConfig
StartTimestring

起始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

示例值:2016-06-29T09:00:00Z
EndTimestring

结束时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

示例值:2016-06-29T11:00:00Z
PageNuminteger<int32>

页码。

示例值:1
PageSizeinteger<int32>

每⻚模板数值,不传默认为 100。

示例值:100
Statusinteger<int32>

状态。 取值:展开详情

示例值:0
ChargeTypeinteger<int32>

付费方式。 取值:展开详情

示例值:0
OrderByModifyAscstring

是否按照导播台的修改时间进行升序排序。展开详情

示例值:false
NormTypestring

导播台规格类型。取值:展开详情

示例值:1
ResourceGroupIdstring

资源组 ID。关于资源组的更多信息,请参见什么是资源组

示例值:rg-aekzw******
Tagarray<object>

标签列表。

子级条数 <= 100

返回参数

字段名称字段详情
CasterListobject
RequestIdstring

请求 ID。

示例值:5c6a2a0df228-4a64- af62-20e91b******
Totalinteger<int32>

导播台数量。

示例值:1

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
InvalidUserId.Malformed
%s诊断
400
MissingParameter
%s诊断
400
InvalidParameter.Malformed
%s诊断
400
InvalidParameter.PageSize
%s诊断
400
InvalidParameter.PageNum
%s诊断
400
InvalidParameter.Status
%s诊断
400
InvalidParameter.StartTime
%s诊断
400
InvalidParameter.EndTime
%s诊断
400
LiveServiceNotFound
%s诊断
403
PermissionDenied
%s诊断
500
InternalError
%s诊断

变更历史

变更时间变更内容概要操作
2024-09-27
新增请求参数Tag
变更返回参数
2024-08-21
新增错误码403
新增请求参数ResourceGroupId
变更返回参数

相关示例

调用DescribeCasters查询导播台列表。
2022-03-16