ModifyCasterProgram - 修改导播台节目单

修改导播台节目单。

接口说明

先通过 AddCasterProgram 接口添加导播台节目单,再调用本接口修改导播台节目单。本接口目前支持的节目类型为视频源和组件。

QPS 限制

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
Episodearray<object>

节目信息。

object

节目信息。

ComponentIdarray

组件列表。按照元素顺序由下而上排列,组件将与视频源同步切换

  • 当节点类型为 Component 时,本参数才有用且必传。
  • 当节点类型为 Resource 时,表示组件与视频源绑定并同步切换。
string

组件列表。按照元素顺序由下而上排列,组件将与视频源同步切换

  • 当节点类型为 Component 时,本参数才有用且必传。
  • 当节点类型为 Resource 时,表示组件与视频源绑定并同步切换。
["a2b8e671-2fe5-4642-a2ec-bf93888****" ]
EndTimestring

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

2016-06-29T10:04:00Z
EpisodeIdstring

节目 ID。如果您通过 AddCasterEpisode 接口添加导播台节目,请查看 AddCasterEpisode 接口调用返回的参数 EpisodeId 值。

a2b8e671-2fe5-4642-a2ec-bf938887****
EpisodeNamestring

节目名称。

program_name_2
EpisodeTypestring

节目类型。取值:

  • Resource:视频源。
  • Component:组件。
Resource
ResourceIdstring

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

a2b8e671-2fe5-4642-a2ec-bf938887****
StartTimestring

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

2016-06-29T09:02:00Z
SwitchTypestring

切换策略。 节点类型为 Resource 视频源时有效。

  • TimeFirst:时间优先,直播类视频源只允许采用时间优先。
  • ContentFirst:内容优先。
TimeFirst
CasterIdstring

导播台 ID。

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

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

说明 直播控制台云导播台页面导播台列表中的导播台名称即导播台 ID。
a2b8e671-2fe5-4642-a2ec-bf93880e****

请求参数必须传一个要修改的节目内容,即至少一个 Episode 属性。

说明 请求参数中的 N 表示第几个的意思。例如:
Episode.N.EpisodeName 表示传入第几个节目名称。Episode.1.EpisodeName 表示传入第 1 个节目名称,Episode.2.EpisodeName 表示传入第 2 个节目名称。

返回参数

名称类型描述示例值
object
CasterIdstring

导播台 ID。

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

请求 ID。

16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息
400MissingParameter%s
400InvalidParameter.Malformed%s
400SwitchTypeInvalid.Malformed%s
400IncorrectStartTime%s
400IncorrectEndTime%s
400IncorrectEpisodeStatus%s
400EpisodeConflict.Malformed%s
400InvalidCasterId.Malformed%s
401IllegalOperation%s
404InvalidCaster.NotFound%s
404InvalidResource.NotFound%s
404InvalidEpisode.NotFound%s
404InvalidComponent.NotFound%s
500InternalError%s

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

变更历史

变更时间变更内容概要操作
暂无变更历史