SetShowListBackground - 播单背景设置

进行播单背景设置。

接口说明

  • 请先创建新播单型导播台,再调用本接口添加背景素材。使用 API 创建导播台,请参见创建导播台

  • 可以使用本接口创建/更新/删除播单背景, 当参数 ResourceType、ResourceUrl、MaterialId 都为空即可删除背景。

重要
  • 使用视频点播(VOD)资源,可优先选择托管 Bucket 资源,自有 Bucket 资源存在过期风险,如果您选用自有 Bucket 资源,需注意资源的有效期时间。

  • 素材资源输入请优先选择视频直播和视频点播的资源,若从第三方 URL 输入资源存在播放失败可能性,需确定资源的质量和有效性。

QPS 限制

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

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

live:SetShowListBackground

update

*Caster

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

请求参数

名称

类型

必填

描述

示例值

RegionId

string

地域 ID。

cn-shanghai

CasterId

string

导播台 ID。

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

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

说明

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

LIVEPRODUCER_POST-cn-0pp1czt****

ResourceType

string

素材类型。取值:

  • LIVE:直播素材。可支持直播素材和第三方 URL。

  • VOD:点播素材。可支持点播素材和第三方 URL。

  • PIC:图片素材。可支持点播素材和第三方 URL。

说明

三选一或者不传。

VOD

MaterialId

string

点播素材 ID。

说明

与外部 ResourceUrl 二选一。

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

ResourceUrl

string

外部素材 url。

http://****/atestObject****.m3u8

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID。

987DA143-A39C-5B5D-AF5B-3B07944A0036

示例

正常返回示例

JSON格式

{
  "RequestId": "987DA143-A39C-5B5D-AF5B-3B07944A0036"
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidUserId.Malformed %s
400 MissingParameter %s
400 InvalidParameter.Malformed %s
400 InvalidParameter.PageSize %s
400 InvalidParameter.PageNum %s
400 InvalidParameter.Status %s
400 InvalidParameter.StartTime %s
400 InvalidParameter.EndTime %s
400 LiveServiceNotFound %s
500 InternalError %s
404 InvalidCaster.NotFound The caster does not exist. 导播不存在。

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

变更历史

更多信息,参考变更详情