KillStream - 断开直播流--视频直播-Volcengine

Docs

视频直播

流管理

KillStream - 断开直播流

This page in your local language is currently not available.

KillStream - 断开直播流

调用 KillStream 接口，可立即断开当前正在进行的推流或拉流，包括断开直推在线流的推流连接，或断开回源流的拉流连接。该接口仅对当前推流或拉流连接生效，断开后推流端仍可重新推流，拉流端仍可重新发起拉流，适用于需要立即中断当前推流或拉流、但允许后续重新连接的场景。

tip

如果 SDK 配置了重试机制，调用本接口断开连接后，直播流仍可能被重新推流或重新拉取。如需在一段时间内阻止再次推拉流，建议使用 ForbidStream 接口。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

请求方式：POST
请求地址：https://live.volcengineapi.com?Action=KillStream&Version=2023-01-01

调试

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`KillStream`	接口名称。当前 API 的名称为 `KillStream`。
Version	String	是	`2023-01-01`	接口版本。当前 API 的版本为 `2023-01-01`。

Body

参数	类型	是否必选	示例值	描述
Vhost	String	是	`push.example.com`	域名空间，您可以调用 DescribeLiveStreamInfoByPage 接口，查看待断开的在线流的信息，包括 `Vhost`、`APP` 和 `Stream`。
App	String	是	`live`	直播流使用的应用名称。
Stream	String	是	`example_stream`	直播流使用的流名称。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST https://live.volcengineapi.com?Action=KillStream&Version=2023-01-01
{
    "Vhost": "push.example.com",
    "App": "live",
    "Stream": "stream001"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "KillStream",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    }
}

错误码

下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。

状态码	错误码	错误信息	说明
200	CommonErr	-	未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400	InvalidParam	-	输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400	InvalidParam.BindError	Request parameter error, please check input data	参数未通过校验，请检查参数类型是否正确。
403	RequestForbidden	-	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403	RequestForbidden.AccountIDNotAllow	this AccountID does not have permission to access the corresponding resource, please check the request parameters	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403	RequestForbidden.BillingStatus	Billing status is not available for the AccountID, please activate the service or recharge.	未开通视频直播服务或账号欠费，造成账单不可用，请检查服务开通情况和账号欠费情况。
404	ResourceNotFound	-	未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。
500	InternalError	an internal error occurred, please contact the administrator.	出现内部错误，请联系技术支持。
502	InternalServiceError	an internal error occurred, please contact the administrator.	服务间出现错误，请联系技术支持。
502	InternalServiceError.BadResponse	an internal error occurred, please contact the administrator.	服务间出现错误，请联系技术支持。
504	InternalServiceTimeout	Internal Service is timeout. please contact the administrator.	内部服务超时，请联系技术支持。

服务端 SDK

视频直播提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。

Last updated: 2026.05.29 17:01:37

视频直播

注意事项 #

请求说明 #

调试 #

请求参数 #

Query #

Body #

返回参数 #

请求示例 #

返回示例 #

错误码 #

服务端 SDK #