调用StopCasterScene停止指定场景。

使用说明

调用本接口停止指定场景，限制仅用于停止PVW场景（预览场景）。

QPS限制

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 StopCasterScene

系统规定参数，取值：StopCasterScene。

CasterId String 是 80787064-1c94-4dc1-85ce-9409960a****

导播台ID。

  • 如果您通过CreateCaster接口创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。
  • 如果您通过直播控制台创建导播台，请通过直播控制台 > 导播台 > 云导播台页面查看。
说明 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。
SceneId String 是 242b4e2c-c30f-4442-85ba-2e3e4e3d****

场景ID。

当场景是PVW场景时，本API接口才可用。场景类型请参见查询导播台场景。

RegionId String 否 cn-shanghai

地域ID。

返回数据

名称 类型 示例值 描述
RequestId String CF60DB6A-7FD6-426E-9288-122CC1A52FA7

请求ID。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=StopCasterScene
&CasterId=80787064-1c94-4dc1-85ce-9409960a****
&SceneId=242b4e2c-c30f-4442-85ba-2e3e4e3d****
&<公共请求参数>

正常返回示例

XML格式 

<StopCasterSceneResponse>
	  <RequestId>CF60DB6A-7FD6-426E-9288-122CC1A52FA7</RequestId>
</StopCasterSceneResponse>

JSON格式 

{
    "StopCasterSceneResponse": {
        "RequestId": "CF60DB6A-7FD6-426E-9288-122CC1A52FA7"
    }
}

错误码

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