CreateCaster - 创建导播台

调用CreateCaster创建导播台。

接口说明

您已开通云导播服务再调用本接口创建导播台。开通指引,请参见开通服务。 本接口目前支持的导播台规格类型为通用型、轻量级轮播型、虚拟演播厅型和新播单型(轮播台)。

QPS 限制

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
live:CreateCastercreate
*Caster
acs:live:*:{#accountId}:caster/{#CasterId}

请求参数

名称类型必填描述示例值
CasterNamestring

导播台名称。

liveCaster****
ClientTokenstring

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

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

53200b81-b761-4c10-842a-a0726d97****
NormTypeinteger

导播台规格类型。取值:

  • 1:通用型。

  • 3:轻量级轮播型。

  • 4:虚拟演播厅型。

  • 6:轮播台(新播单型导播台)。

1
ChargeTypestring

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

  • PrePaid:预付费(暂不支持)。
  • PostPaid:后付费。
PostPaid
PurchaseTimestring

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

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

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

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

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

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

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

rg-aekzw******
Tagarray<object>

标签列表。

object

标签列表。

Keystring

标签健。

TestKey
Valuestring

标签值。

TestValue

返回参数

名称类型描述示例值
object
CasterIdstring

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

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

请求 ID。

16A96B9A-F203-4EC5-8E43-CB92E68F****

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息
400InvalidParameter.PurchaseTime%s
400InvalidParameter.ExpireTime%s
400MissingParameter%s
400InvalidChargeType.Malformed%s
400InvalidChargeType.PostSupport%s
400InvalidCasterTemplate.Malformed%s
400InvalidParameter.Malformed%s
400InvalidParameter.ChargeType%s
400InvalidPeriod.Malformed%s
400InvalidUserId.Malformed%s
400InvalidClientToken.Malformed%s
400IncorrectCasterStatus%s
401CasterNumberExceed%s
403PermissionDenied%s
404InvalidParameter.NormType%s
404InvalidConfiguration.NotFound%s
408CreateCaster.Timeout%s

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

变更历史

变更时间变更内容概要操作
2024-09-27OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2024-08-21OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情