DeleteStream - 删除视频流--慢直播-火山引擎

文档中心

立即注册

导航

DeleteStream - 删除视频流

最近更新时间：2025.06.06 14:20:32首次发布时间：2021.11.25 17:21:46

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

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=DeleteStream&Version=2021-01-01

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	DeleteStream	要执行的操作，取值：DeleteStream。
Version	String	是	2021-01-01	API的版本，取值：2021-01-01。
StreamID	String	是	3a890d3f-6db4-4663-a5a6-9abf0683627f	视频流 ID，可通过调用 ListStreams 接口获取

返回参数

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

参数	类型	示例值	描述
ID	String	3a890d3f-6db4-4663-a5a6-9abf0683627f	删除成功的视频流 ID

请求示例

POST https://open.volcengineapi.com?Action=DeleteStream&Version=2021-01-01&StreamID=3a890d3f-6db4-4663-a5a6-9abf0683627f

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021120816122001021215002121000451",
        "Action": "DeleteStream",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "ID": "3a890d3f-6db4-4663-a5a6-9abf0683627f"
    }
}

错误码

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

状态码	错误码	错误信息
500	ErrorStreamDBNotFound	NotFound.Stream
500	InternalErrorStreamDB	InternalError.StreamDB
500	UpdateStreamStatus	InternalError.UpdateStreamStatus
500	ErrorStreamManuNotAllowed	OperationDeny.ManuStream
500	NotFound.Stream	The request is failed due to stream not found.