停止指定场景,限制仅用于停止PVW场景(预览场景)。
接口说明
调用本接口停止指定场景,限制仅用于停止 PVW 场景(预览场景)。
QPS 限制
本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
live:StopCasterScene |
update |
*Caster
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
否 |
地域 ID。 |
cn-shanghai |
| CasterId |
string |
是 |
导播台 ID。
说明
直播控制台云导播台页面导播台列表中的导播台名称即导播台 ID。 |
80787064-1c94-4dc1-85ce-9409960a**** |
| SceneId |
string |
是 |
场景 ID。 当场景是 PVW 场景时,本 API 接口才可用。场景类型请参见查询导播台场景。 |
242b4e2c-c30f-4442-85ba-2e3e4e3d**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
CF60DB6A-7FD6-426E-9288-122CC1A52FA7 |
示例
正常返回示例
JSON格式
{
"RequestId": "CF60DB6A-7FD6-426E-9288-122CC1A52FA7"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidCasterId.Malformed | %s | |
| 400 | InvalidUserId.Malformed | %s | |
| 400 | InvalidSceneId.Malformed | %s | |
| 400 | IncorrectSceneStatus | %s | |
| 400 | IncorrectSceneStatus.Idle | %s | |
| 401 | IllegalOperation | %s | |
| 500 | InternalError | %s | |
| 404 | InvalidCaster.NotFound | %s | |
| 404 | InvalidScene.NotFound | %s |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。