停用、禁用或解禁指定视频流(适用于接入类型为 GB 的空间内的视频流)。
使用 POST 方式发起请求。
下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表,参考「公共参数」。
字段 | 位置 | 类型 | 必填 | 说明 | 值 |
---|---|---|---|---|---|
Action | Query | String | 是 | 公共参数,OpenAPI 接口名称 | StopStream / ForbidStream / UnforbidStream |
Version | Query | String | 是 | 公共参数,OpenAPI 接口版本 | 2021-01-01 |
StreamID | Query | String | 是 | 视频流 ID | 可通过调用 ListStreams 接口获取 |
通用返回参数,请参考 ResponseMetadata 结构体说明。
Result 字段包含以下参数:
字段 | 类型 | 说明 |
---|---|---|
ID | String | 停用、禁用或解禁成功的视频流 ID |
POST https://open.volcengineapi.com?Action=StopStream &Version=2021-01-01 &StreamID=4b9ee060-9fed-4c0e-aaa4-283b17xxxxxx &<公共请求参数>
{ "ResponseMetadata": { "RequestId": "202112081609140102120720962400088F", "Action": "StopStream", "Version": "2021-01-01", "Service": "aiotvideo", "Region": "cn-north-1" }, "Result": { "ID": "4b9ee060-9fed-4c0e-aaa4-283b17xxxxxx" } }