StopStream - 停用视频流--慢直播-火山引擎

文档中心

立即注册

导航

StopStream - 停用视频流

最近更新时间：2025.06.16 17:35:59首次发布时间：2025.06.16 17:35:59

停用指定视频流（适用于接入类型为 GB 的空间内的视频流）。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	StopStream	要执行的操作，取值：StopStream。
Version	String	是	2021-01-01	API的版本，取值：2021-01-01。
StreamingIndex	Integer	否	0	子码流
StreamID	String	是	4b9ee060-9fed-4c0e-aaa4-283b17xxxxxx	视频流 ID，可通过调用 ListStreams 接口获取
Resolution	String	否	1	分辨率
IsSmart	String	否	1	是否检测有人在拉流，无人拉流才停流，1表示使能

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
StopRes	Boolean	true	是否停止成功
ID	String	4b9ee060-9fed-4c0e-aaa4-283b17xxxxxx	停用成功的视频流 ID

请求示例

POST /?Action=StopStream&Version=2021-01-01&StreamID=4b9ee060-9fed-4c0e-aaa4-283b17xxxxxx HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241219T034647Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241219/cn-beijing/aiotvideo/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202412191147010282491630747CB1F9",
    "Action": "StopStream",
    "Version": "2021-01-01",
    "Service": "aiotvideo",
    "Region": "cn-beijing"
  },
  "Result": {
    "StopRes": true,
    "ID": "4b9ee060-9fed-4c0e-aaa4-283b17xxxxxx"
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息
400	ErrorStreamDBNotFound	NotFound.Stream
400	InvalidOperationStreamCancel	InvalidOperation.StreamCancel
500	InternalErrorStreamDB	InternalError.StreamDB
500	InternalError.StreamDB	The request is failed due to the stream can not be found due to db err.