全量设置场景配置，清空场景配置，并将布局信息设置并生效至指定场景。
接口说明
使用说明
调用本接口全量设置场景配置，清空场景配置，并将布局信息设置并生效至指定场景。
QPS 限制
本接口的单用户 QPS 限制为 10 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 QPS 限制。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| live:SetCasterSceneConfig | update |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ComponentId | array | 否 | 组件 ID 列表，数组内按照由下至上的顺序排列组件。 说明
N 表示第几个的意思。例如： ComponentId.1 表示第一个组件 ID， ComponentId.2 表示第二个组件 ID。 | |
| string | 否 | 组件 ID 列表，数组内按照由下至上的顺序排列组件。 说明
N 表示第几个的意思。例如： ComponentId.1 表示第一个组件 ID， ComponentId.2 表示第二个组件 ID。 | [ "a2b8e671-2fe5-4642-a2ec-bf931826****", "a2b8e671-2fe5-4642-a2ec-28374657****"] | |
| CasterId | string | 是 | 导播台 ID。
说明
直播控制台云导播台页面导播台列表中的导播台名称即导播台 ID。
| 80787064-1c94-4dc1-85ce-9409960a**** |
| SceneId | string | 是 | 场景 ID。 | 242b4e2c-c30f-4442-85ba-2e3e4e3d**** |
| LayoutId | string | 否 | 布局 ID。如果您通过 DescribeCasterLayouts 接口查询导播台布局列表，请查看 DescribeCasterLayouts 接口调用返回的参数 LayoutId 值。 | 0c6da077-f037-49e8-8440-3be13393**** |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "CF60DB6A-7FD6-426E-9288-122CC1A52FA7"
}错误码
| HTTP status code | 错误码 | 错误信息 |
|---|---|---|
| 400 | InvalidCasterId.Malformed | %s |
| 400 | InvalidUserId.Malformed | %s |
| 400 | InvalidSceneId.Malformed | %s |
| 400 | InvalidCaptionResource | %s |
| 400 | IncorrectSceneStatus | %s |
| 400 | ComponentNumberExceed | %s |
| 400 | IncorrectSceneStatus.Idle | %s |
| 400 | IncorrectSceneStatus.ConfigError | %s |
| 400 | InvalidParameter.Malformed | %s |
| 401 | IllegalOperation | %s |
| 404 | InvalidCaster.NotFound | %s |
| 404 | InvalidScene.NotFound | %s |
| 404 | InvalidLayout.NotFound | %s |
| 404 | InvalidComponent.NotFound | %s |
| 404 | ResourceInChannel.NotFound | %s |
| 412 | ResourceInChannel.PreConditionFailed | %s |
| 412 | ResourceInChannel.Invalid | %s |
| 500 | InternalError | %s |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史