调用StopCaster停止导播台。

使用说明

先通过CreateCaster接口创建导播台,再调用本接口停止导播台。停止PVW(预览场景)、PGM(正式输出场景)场景。

QPS限制

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

调试

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

请求参数

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

系统规定参数,取值:StopCaster

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

导播台ID。

  • 如果您通过CreateCaster接口创建导播台,请查看CreateCaster接口调用返回的参数CasterId值。
  • 如果您通过直播控制台创建导播台,请通过直播控制台 > 导播台 > 云导播台页面查看。
说明 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。
RegionId String cn-shanghai

地域ID。

返回数据

名称 类型 示例值 描述
RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

请求ID。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=StopCaster
&CasterId=80787064-1c94-4dc1-85ce-9409960a****
&<公共请求参数>

正常返回示例

XML格式

<StopCasterResponse>
	  <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
</StopCasterResponse>

JSON格式

{
    "StopCasterResponse": {
        "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
    }
}

错误码

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