DescribeCasters - 查询导播台列表_视频直播(LIVE)-阿里云帮助中心

调用DescribeCasters查询导播台列表。

接口说明

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

QPS 限制

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

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

请求参数

名称	类型	必填	描述	示例值
CasterId	string	否	导播台 ID。如果您通过 CreateCaste 接口创建导播台，请查看 CreateCaster 接口调用返回的参数 CasterId 值。如果您通过直播控制台创建导播台，请通过直播控制台 > 导播台 > 云导播台页面查看。说明直播控制台云导播台页面导播台列表中的导播台名称即导播台 ID。若参数为空，默认返回所有导播台合并后的数据。	LIVEPRODUCER_POST-cn-0pp1czt****
CasterName	string	否	导播台名称。	liveCaster****
StartTime	string	否	起始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2016-06-29T09:00:00Z
EndTime	string	否	结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2016-06-29T11:00:00Z
PageNum	integer	否	页码。	1
PageSize	integer	否	每⻚模板数值，不传默认为 100。	100
Status	integer	否	状态。取值： 0：空闲。 1：导播中。	0
ChargeType	integer	否	付费方式。取值： 0：PrePaid 预付费。 1：PostPaid 后付费。	0
OrderByModifyAsc	string	否	是否按照导播台的修改时间进行升序排序。说明不填默认为"false"。	false
NormType	string	否	导播台规格类型。取值： 1：通用型。 3：轻量级轮播型。 4：虚拟演播厅型。 6：轮播台（新播单型导播台）。	1
ResourceGroupId	string	否	资源组 ID。关于资源组的更多信息，请参见什么是资源组。	rg-aekzw******
Tag	array<object>	否	标签列表。
	object	否	标签列表。
Key	string	否	标签健。	TestKey
Value	string	否	标签值。	TestValue

返回参数

名称	类型	描述	示例值
	object	导播台数量。
CasterList	array<object>	导播台信息列表。
Caster	object	导播台信息。
CasterId	string	导播台 ID。可作为查询导播台流地址、启动导播台、添加导播台视频资源、添加导播台布局、查询导播台布局列表、添加导播台组件和添加导播台节目单的请求参数。	LIVEPRODUCER_POST-cn-0pp1czt****
CasterName	string	导播台名称。	liveCaster****
CasterTemplate	string	导播台分辨率配置，付费类型为预付费时必选。 lp_ld：流畅。 lp_sd：标清。 lp_hd：高清。 lp_ud：超清。 lp_ld_v：竖屏流畅。 lp_sd_v：竖屏标清。 lp_hd_v：竖屏高清。 lp_ud_v：竖屏超清。	lp_ld
ChannelEnable	integer	是否启用 Channel。 0：不启用。 1：启用。	1
ChargeType	string	付费方式。 PrePaid：预付费。 PostPaid：后付费。	PrePaid
CreateTime	string	创建时间。	2017-08-30 12:02:57.0
Duration	string	时长。格式为：hh:mm:ss（时：分：秒）。	1:02:33
ExpireTime	string	导播台过期时间。	2018-08-30 12:02:57.0
LastModified	string	对导播台最新修改时间。例如：近期有对导播台进行过开启，停止，修改配置等操作的时间。	2021-12-01T05:08:45Z
NormType	integer	导播台规格类型。取值： 0：播单型。 1：通用型。	1
PurchaseTime	string	导播台购买时间。	2017-08-30 12:02:57.0
StartTime	string	导播台启动时间，当导播台处于导播中时输出。	2017-08-30 18:02:57.0
Status	integer	状态。取值： 0：空闲。 1：导播中。	1
ResourceGroupId	integer	资源组 ID。关于资源组的更多信息，请参见什么是资源组。	rg-acfmz******
ClientTokenId	string	用户生成的请求 token，用于保证请求的幂等性。该参数值可自定义，但是要保证在不同请求间唯一，最大值不超过 64 个 ASCII 字符。	53200b81-b761-4c10-842a-a0726d97****
Tags	array<object>	标签列表。
tag	object	标签。
TagKey	string	标签键。	TestKey
TagValue	string	标签值。	TestValue
RequestId	string	请求 ID。	5c6a2a0df228-4a64- af62-20e91b******
Total	integer	导播台数量。	1

示例

正常返回示例

JSON格式

{
  "CasterList": {
    "Caster": [
      {
        "CasterId": "LIVEPRODUCER_POST-cn-0pp1czt****",
        "CasterName": "liveCaster****",
        "CasterTemplate": "lp_ld",
        "ChannelEnable": 1,
        "ChargeType": "PrePaid",
        "CreateTime": "2017-08-30 12:02:57.0",
        "Duration": "1:02:33",
        "ExpireTime": "2018-08-30 12:02:57.0",
        "LastModified": "2021-12-01T05:08:45Z",
        "NormType": 1,
        "PurchaseTime": "2017-08-30 12:02:57.0",
        "StartTime": "2017-08-30 18:02:57.0",
        "Status": 1,
        "ResourceGroupId": 0,
        "ClientTokenId": "53200b81-b761-4c10-842a-a0726d97****\n",
        "Tags": {
          "tag": [
            {
              "TagKey": "TestKey",
              "TagValue": "TestValue"
            }
          ]
        }
      }
    ]
  },
  "RequestId": "5c6a2a0df228-4a64- af62-20e91b******",
  "Total": 1
}

错误码

HTTP status code	错误码	错误信息
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	OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-08-21	OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情