调用DescribeCasters查询导播台列表。

使用说明

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

QPS限制

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeCasters

系统规定参数。取值:DescribeCasters

CasterId String LIVEPRODUCER_POST-cn-0pp1czt****

导播台ID。

  • 如果您通过CreateCaster接口创建导播台,请查看CreateCaster接口调用返回的参数CasterId值。
  • 如果您通过直播控制台创建导播台,请通过直播控制台 > 导播台 > 云导播台页面查看。
说明 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。
CasterName String liveCaster****

导播台名称。

StartTime String 2016-06-29T09:00:00Z

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

EndTime String 2016-06-29T11:00:00Z

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

PageNum Integer 1

页码。

PageSize Integer 5

每页条数。

Status Integer 0

状态。 取值:

  • 0:空闲 。
  • 1:导播中 。
ChargeType Integer 0

付费方式。 取值:

  • 0:PrePaid预付费 。
  • 1:PostPaid后付费。
OrderByModifyAsc String false

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

不填默认为"false"。

返回数据

名称 类型 示例值 描述
CasterList Array of Caster

导播台信息列表。

Caster
CasterId String LIVEPRODUCER_POST-cn-0pp1czt****

导播台ID。可作为查询导播台流地址、启动导播台、添加导播台视频资源、添加导播台布局、查询导播台布局列表、添加导播台组件和添加导播台节目单的请求参数。

CasterName String liveCaster****

导播台名称。

CasterTemplate String lp_ld

导播台分辨率配置,付费类型为预付费时必选。

  • lp_ld:流畅 。
  • lp_sd:标清 。
  • lp_hd:高清。
  • lp_ud:超清。
  • lp_ld_v:竖屏流畅。
  • lp_sd_v:竖屏标清。
  • lp_hd_v:竖屏高清。
  • lp_ud_v:竖屏超清。
ChannelEnable Integer 1

是否启用Channel。

  • 0:不启用。
  • 1:启用。
ChargeType String PrePaid

付费方式。

  • PrePaid:预付费 。
  • PostPaid:后付费。
CreateTime String 2017-08-30 12:02:57.0

创建时间。

Duration String 2000

时长。单位:分钟。

ExpireTime String 2018-08-30 12:02:57.0

导播台过期时间。

LastModified String 2021-12-01T05:08:45Z

对导播台最新修改时间。例如:近期有对导播台进行过开启,停止,修改配置等操作的时间。

NormType Integer 1

导播台规格类型 。 取值:

  • 0:播单型。
  • 1:通用型。
PurchaseTime String 2017-08-30 12:02:57.0

导播台购买时间。

StartTime String 2017-08-30 18:02:57.0

导播台启动时间,当导播台处于导播中时输出。

Status Integer 1

状态。取值:

  • 0:空闲。
  • 1:导播中。
RequestId String 6159ba01-6687-4fb2-a831-f0cd8d188648

请求ID。

Total Integer 1

导播台数量。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=DescribeCasters
&<公共请求参数>

正常返回示例

XML格式

<DescribeCastersResponse>
  <RequestId>6159ba01-6687-4fb2-a831-f0cd8d188648</RequestId>
  <Total>1</Total>
  <CasterList>
        <Caster>
              <LastModified>2021-12-01T05:08:45Z</LastModified>
              <Status>1</Status>
              <CasterTemplate> lp_ld</CasterTemplate>
              <PurchaseTime>2017-08-30 12:02:57.0</PurchaseTime>
              <CasterName>liveCaster****</CasterName>
              <ChannelEnable>1</ChannelEnable>
              <ChargeType> PrePaid</ChargeType>
              <CreateTime>2017-08-30 12:02:57.0</CreateTime>
              <StartTime>2017-08-30 18:02:57.0</StartTime>
              <NormType>1</NormType>
              <Duration>2000</Duration>
              <ExpireTime>2018-08-30 12:02:57.0</ExpireTime>
              <CasterId>LIVEPRODUCER_POST-cn-0pp1czt****</CasterId>
        </Caster>
  </CasterList>
</DescribeCastersResponse>

JSON格式

{
    "DescribeCastersResponse": {
        "RequestId": "6159ba01-6687-4fb2-a831-f0cd8d188648",
        "Total": 1,
        "CasterList": {
            "Caster": {
                "LastModified": "2021-12-01T05:08:45Z",
                "Status": 1,
                "CasterTemplate": "lp_ld",
                "PurchaseTime": "2017-08-30 12:02:57.0",
                "CasterName": "liveCaster****",
                "ChannelEnable": 1,
                "ChargeType": "PrePaid",
                "CreateTime": "2017-08-30 12:02:57.0",
                "StartTime": "2017-08-30 18:02:57.0",
                "NormType": 1,
                "Duration": 2000,
                "ExpireTime": "2018-08-30 12:02:57.0",
                "CasterId": "LIVEPRODUCER_POST-cn-0pp1czt****"
            }
        }
    }
}

错误码

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