添加导播台节目单。
接口说明
请先创建导播台,添加导播台视频资源后再调用本接口添加导播台节目单。本接口目前只支持视频源和组件两种节点类型。使用 API 创建导播台,请参见创建导播台。
QPS 限制
本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
live:AddCasterProgram | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Episode | array<object> | 是 | 节目单信息。 | |
object | 是 | 节目单信息。 | ||
ComponentId | array | 否 | 组件列表。按照元素顺序由下而上排列。 注意 当 Episode.N.EpisodeType 为 Component 时,本参数有用且必传。
当节点类型为 Resource 时,表示组件与视频源绑定并同步切换。 | |
string | 否 | 组件 ID。 | a2b8e671-2fe5-4642-a2ec-bf931826**** | |
EndTime | string | 否 | 结束时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 | 2016-06-29T10:02:00Z |
EpisodeName | string | 否 | 节目名称。 | program_name_1 |
EpisodeType | string | 否 | 节点类型。
| Resource |
ResourceId | string | 否 | 视频源 ID。 注意 当 Episode.N.EpisodeType 为 Resource 时,本参数有用且必传。
当 Episode.N.EpisodeType 为 Component 时,本参数不可用。 如果您通过 AddCasterVideoResource 接口添加导播台视频源,请查看 AddCasterVideoResource 接口调用返回的参数 ResourceId 值。 | a2b8e671-2fe5-4642-a2ec-bf93880e**** |
StartTime | string | 否 | 起始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 | 2016-06-29T09:00:00Z |
SwitchType | string | 否 | 切换策略。取值: 注意 当 Episode.N.EpisodeType 为 Resource 时,本参数才有用。
| TimeFirst |
CasterId | string | 是 | 导播台 ID。
说明
直播控制台云导播台页面导播台列表中的导播台名称即导播台 ID。
| LIVEPRODUCER_POST-cn-0pp1czt**** |
说明
请求参数中的 N 表示第几个的意思。例如:
Episode.N.EpisodeName 表示传入第几个节目名称。Episode.1.EpisodeName 表示传入第 1 个节目名称,Episode.2.EpisodeName 表示传入第 2 个节目名称。
Episode.N.EpisodeName 表示传入第几个节目名称。Episode.1.EpisodeName 表示传入第 1 个节目名称,Episode.2.EpisodeName 表示传入第 2 个节目名称。
返回参数
示例
正常返回示例
JSON
格式
{
"EpisodeIds": {
"EpisodeId": [
{
"EpisodeId": "16A96B9A-F203-4EC5-8E43-CB92E68F****"
}
]
},
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F****"
}
错误码
HTTP status code | 错误码 | 错误信息 |
---|---|---|
400 | MissingParameter | %s |
400 | InvalidParameter.Malformed | %s |
400 | SwitchTypeInvalid.Malformed | %s |
400 | IncorrectStartTime | %s |
400 | IncorrectEndTime | %s |
400 | EpisodeConflict.Malformed | %s |
400 | InvalidCasterId.Malformed | %s |
400 | InvalidParameter.EndTime | %s |
401 | IllegalOperation | %s |
404 | InvalidCaster.NotFound | %s |
404 | InvalidResource.NotFound | %s |
404 | InvalidComponent.NotFound | %s |
500 | InternalError | %s |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史