调用CreateCaster创建导播台。

使用说明

您已开通云导播服务再调用本接口创建导播台。开通指引,请参见开通服务

本接口目前支持的导播台规格类型为通用型和新播单型(轮播台)。

QPS限制

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

调试

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

请求参数

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

系统规定参数。取值:CreateCaster

CasterName String liveCaster****

导播台名称。

ClientToken String 53200b81-b761-4c10-842a-a0726d97****

用户生成的请求token。用于保证请求的幂等性。

该参数值可自定义,但是要保证在不同请求间唯一,最大值不超过64个ASCII字符。

NormType Integer 1

导播台规格类型。取值:

  • 1:通用型。
  • 6:轮播台(新播单型导播台)。
ChargeType String PostPaid

付费方式。 目前只支持PostPaid。取值:

  • PrePaid:预付费(暂不支持)。
  • PostPaid:后付费。
PurchaseTime String 2017-08-20T12:10:10Z

导播台购买时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

说明ChargeTypePrePaid时,此参数才可设置。
ExpireTime String 2017-08-22T12:10:10Z

导播台过期时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

说明ChargeTypePrePaid时,此参数才可设置。
CasterTemplate String lp_sd

导播台预设分辨率。采用预付费方式时,取值:

  • lp_ld:流畅。
  • lp_sd:标清。
  • lp_hd:高清。
  • lp_ud:超清。
  • lp_ld_v:竖屏流畅。
  • lp_sd_v:竖屏标清。
  • lp_hd_v:竖屏高清。
  • lp_ud_v:竖屏超清。
说明 后付费场景下,需要设置分辨率,请调用SetCasterConfig接口进行操作。

返回数据

名称 类型 示例值 描述
CasterId String a2b8e671-2fe5-4642-a2ec-bf93880e****

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

RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

请求ID。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=CreateCaster
&ChargeType=PostPaid
&ClientToken=53200b81-b761-4c10-842a-a0726d97****
&NormType=1
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<CreateCasterResponse>
<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
<CasterId>a2b8e671-2fe5-4642-a2ec-bf93880e1****</CasterId>
</CreateCasterResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "CreateCasterResponse" : {
    "RequestId" : "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
    "CasterId" : "a2b8e671-2fe5-4642-a2ec-bf93880e1****"
  }
}

错误码

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