AddCasterEpisode - 添加导播台节目

添加导播台节目。

接口说明

调用本接口必须提前获取导播台 ID。导播台 ID 在创建导播台后生成。

  • 如果您通过 CreateCaster 接口创建导播台,请查看 CreateCaster 接口调用返回的参数 CasterId 值。

  • 如果您通过直播控制台创建导播台,请通过直播控制台 > 导播台 > 云导播台路径查看导播台名称。

说明

直播控制台云导播台页面导播台列表中的导播台名称即导播台 ID。

QPS 权限

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

live:AddCasterEpisode

create

*Caster

acs:live:*:{#accountId}:caster/{#CasterId}

请求参数

名称

类型

必填

描述

示例值

RegionId

string

地域 id。

cn-shanghai

ComponentId

array

组件列表。按照元素顺序由下而上排列。

如果您通过 AddCasterComponent 接口添加导播台组件,请查看 AddCasterComponent 接口调用返回的参数 ComponentId 值。

  • 当资源类型为 Component 时,参数有用且必传。

  • 当资源类型为 Resource 时,参数非必传,传入时表示组件与视频源绑定并同步切换。

说明

N 表示第几个组件 ID。例如:ComponentId.1表示传入第一个组件 ID;ComponentId.2表示传入第 2 个组件 ID。

["a2b8e671-2fe5-4642-a2ec-bf93880e****"]

string

组件 ID

21926b36-7dd2-4fde-ae25-51b5bc8e****

CasterId

string

导播台 ID。

  • 如果您通过 CreateCaster 接口创建导播台,请查看 CreateCaster 接口调用返回的参数 CasterId 值。

  • 如果您通过直播控制台创建导播台,请通过直播控制台> 导播台 > 云导播台页面查看。

说明

直播控制台云导播台页面导播台列表中的导播台名称即导播台 ID。

LIVEPRODUCER_POST-cn-0pp1czt****

EpisodeType

string

节点类型。 取值:

  • Resource:视频源。如果选择 Resource 类型,必须同时设置请求参数 ResourceId 和 SwitchType。

  • Component:组件。

Resource

EpisodeName

string

节目名称。

episode_1

ResourceId

string

视频源 ID。

重要

当 EpisodeType(节点类型)设为 Resource 时本参数有用且必传。

如果您通过 AddCasterVideoResource 接口添加导播台视频源,请查看 AddCasterVideoResourcer 接口调用返回的参数 ResourceId 值。

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

StartTime

string

起始时间。 格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2016-06-29T08:00:00Z

EndTime

string

结束时间。 格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2016-06-29T09:10:00Z

SwitchType

string

切换策略。取值:

重要

当 EpisodeType(节点类型)设为 Resource 时本参数才有效。

  • TimeFirst:时间优先 。

  • ContentFirst:内容优先。

说明

更多关于视频源的信息,请参见添加视频源

TimeFirst

返回参数

名称

类型

描述

示例值

object

EpisodeId

string

节目 ID。可作为查询导播台节目单、修改导播台节目、删除导播台节目的请求参数。

21926b36-7dd2-4fde-ae25-51b5bc8e****

RequestId

string

请求 ID。

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

示例

正常返回示例

JSON格式

{
  "EpisodeId": "21926b36-7dd2-4fde-ae25-51b5bc8e****",
  "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
401 IllegalOperation %s
500 InternalError %s
404 InvalidCaster.NotFound %s
404 InvalidResource.NotFound %s
404 InvalidComponent.NotFound %s

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

变更历史

更多信息,参考变更详情