添加节目单项。
接口说明
先创建导播台,添加导播台布局和导播台组件,再调用本接口添加节目单项。若没有创建过节目单,则直接创建。使用 API 创建导播台请参考创建导播台。
QPS 限制
本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
live:AddPlaylistItems | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
CasterId | string | 是 | 导播台 ID。
说明
直播控制台云导播台页面导播台列表中的导播台名称即导播台 ID。
导播台需满足如下配置:
| 0e94d1f4-1a65-445c-9dcf-de8b3b8d**** |
ProgramItems | string | 是 | 节目单项输入列表。为 JSON 字符串,更多信息,请参见 InputProgramItem。 | [{"ItemName":"item1","ResourceType":"vod","ResourceValue":"5f8809f2-3352-4d1f-a8f7-86f9429f****"}, {"ItemName": "item2","ResourceType": "vod","ResourceValue": "e7411c0b-dd98-4c61-a545-f8bfba6c****"}] |
ProgramId | string | 否 | 节目单 ID。不填则默认创建一个新的节目单。 | 445409ec-7eaa-461d-8f29-4bec2eb9**** |
ProgramConfig | string | 否 | 节目单项配置。若首次添加,传该参数进行初始化配置。更多信息,请参见 ProgramConfig。 | [{"RepeatNumber":"0","ProgramName":"my program"}] |
InputProgramItem
参数名称 | 示例值 | 类型 | 描述 |
---|---|---|---|
ItemName | item1 | String | 节目单项名称。 |
ResourceType | vod | String | 资源类型。取值: vod:阿里云视频点播资源。 url:第三方视频资源。 |
ResourceValue | 5f8809f2-3352-4d1f-a8f7-86f9429f**** | String | 当 ResourceType 为 vod 时,ResourceValue 为媒资 ID。 当 ResourceType 为 URL 时,ResourceValue 为第三方视频 URL。 |
ProgramConfig
参数名称 | 示例值 | 类型 | 描述 |
---|---|---|---|
RepeatNumber | 0 | Integer | 播放完后重复继续播放的次数。取值: 0(默认值):不重复播放。 -1:一直循环重复。 其他正整数:播放完后重复继续播放的次数。 |
ProgramName | myprogram | String | 节目单名称。 |
返回参数
示例
正常返回示例
JSON
格式
{
"Items": {
"FailedItems": [
{
"ItemId": "c09f3d63-eacf-4fbf-bd48-a07a6ba7****",
"ItemName": "item1"
}
],
"SuccessItems": [
{
"ItemId": "c09f3d63-eacf-4fbf-bd48-a07a6ba7****",
"ItemName": "item2"
}
]
},
"ProgramId": "445409ec-7eaa-461d-8f29-4bec2eb9****",
"RequestId": "5c6a2a0d-f228-4a64-af62-20e91b96****"
}
错误码
HTTP status code | 错误码 | 错误信息 |
---|---|---|
400 | InvalidCasterId.Malformed | %s |
400 | PlayListIsEmpty | %s |
400 | MissInputParams | %s |
400 | InvalidProgramId.Malformed | %s |
400 | InvalidParameter.Malformed | %s |
403 | UserQuotaExceed | %s |
404 | InvalidCaster.NotFound | %s |
404 | InvalidDomainName.NotFound | %s |
500 | InternalError | %s |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史