调用CreateCaster创建导播台。
接口说明
您已开通云导播服务再调用本接口创建导播台。开通指引,请参见开通服务。 本接口目前支持的导播台规格类型为通用型、轻量级轮播型、虚拟演播厅型和新播单型(轮播台)。
QPS 限制
本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
live:CreateCaster | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
CasterName | string | 否 | 导播台名称。 | liveCaster**** |
ClientToken | string | 是 | 用户生成的请求 token。用于保证请求的幂等性。 该参数值可自定义,但是要保证在不同请求间唯一,最大值不超过 64 个 ASCII 字符。 | 53200b81-b761-4c10-842a-a0726d97**** |
NormType | integer | 是 | 导播台规格类型。取值:
| 1 |
ChargeType | string | 是 | 付费方式。 目前只支持 PostPaid。取值:
| PostPaid |
PurchaseTime | string | 否 | 导播台购买时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 说明
当 ChargeType 为 PrePaid 时,此参数才可设置。
| 2017-08-20T12:10:10Z |
ExpireTime | string | 否 | 导播台过期时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 说明
当 ChargeType 为 PrePaid 时,此参数才可设置。
| 2017-08-22T12:10:10Z |
CasterTemplate | string | 否 | 导播台预设分辨率。采用预付费方式时,取值:
说明
后付费场景下,需要设置分辨率,请调用 SetCasterConfig 接口进行操作。
| lp_sd |
ResourceGroupId | string | 否 | 资源组 ID。关于资源组的更多信息,请参见什么是资源组。 | rg-aekzw****** |
Tag | array<object> | 否 | 标签列表。 | |
object | 否 | 标签列表。 | ||
Key | string | 否 | 标签健。 | TestKey |
Value | string | 否 | 标签值。 | TestValue |
返回参数
示例
正常返回示例
JSON
格式
{
"CasterId": "a2b8e671-2fe5-4642-a2ec-bf93880e****",
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F****"
}
错误码
HTTP status code | 错误码 | 错误信息 |
---|---|---|
400 | InvalidParameter.PurchaseTime | %s |
400 | InvalidParameter.ExpireTime | %s |
400 | MissingParameter | %s |
400 | InvalidChargeType.Malformed | %s |
400 | InvalidChargeType.PostSupport | %s |
400 | InvalidCasterTemplate.Malformed | %s |
400 | InvalidParameter.Malformed | %s |
400 | InvalidParameter.ChargeType | %s |
400 | InvalidPeriod.Malformed | %s |
400 | InvalidUserId.Malformed | %s |
400 | InvalidClientToken.Malformed | %s |
400 | IncorrectCasterStatus | %s |
401 | CasterNumberExceed | %s |
403 | PermissionDenied | %s |
404 | InvalidParameter.NormType | %s |
404 | InvalidConfiguration.NotFound | %s |
408 | CreateCaster.Timeout | %s |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-09-27 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2024-08-21 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |