使用 SID 强制断开推流

更新时间不可用

使用推流会话 ID 强制断开正在进行的推流。

DELETE
https://api.sd-rtn.com/{region}/v1/projects/{appId}/rtls/ingress/online-streams/{sid}

使用推流会话 ID(SID)断开指定的正在进行的推流。

你可以结合该接口和销毁推流码 API,实现禁用流的功能。销毁推流码只会将推流码从数据库删除,之后就不能再使用该推流码,但不能断开正在进行的推流。如需断开正在进行的推流,你可以参考如下操作:

注意

一定要先销毁推流码,否则单独使用本接口强制断开后,推流软件会立即重连上来,此时会生成一个新的推流会话(对应一个新的 sid),断开失败。

鉴权

Basic Auth

HTTP 基本认证:每次发送 HTTP 请求时,都必须在请求 Header 部填入 Authorization 字段。关于如何生成该字段的值,请参考实现 HTTP 基本认证。

API Key

HTTP HMAC 认证:每次发送 HTTP 请求时,都必须在请求 Header 部填入 Authorization 字段。关于如何生成该字段的值,请参考实现 HTTP HMAC 认证。

路径参数

regionstring
必填

创建推流码的区域。声网支持分区域创建推流码,目前支持以下区域:

  • cn:中国大陆
  • ap:除中国大陆以外的亚洲区域
  • na:北美
  • eu:欧洲

注意

  • 请确保设置的 region 与输入的源流在同一个区域。
  • 请确保设置的 region 与推流使用的域名在同一个区域。
  • 请确保传入 region 的值为小写。
appIdstring
必填

声网为每个开发者提供的 App ID。在声网控制台创建一个项目后即可得到一个 App ID。App ID 是一个项目的唯一标识。

sidstring
必填

推流会话 ID(Session ID),是每次发起的推流任务的唯一标识。可以通过查询当前在推流列表 API 获得,也可通过接收消息通知回调的 Payload 获取。

请求 Header

X-Request-IDstring

本次请求的 UUID(通用唯一识别码)。传入该字段后,声网服务器会在响应 Header 中返回该字段。声网推荐你对 X-Request-ID 赋值。如果不赋值,声网服务器会自动生成一个 UUID 传入。

响应

如果状态码为 2XX,则请求成功。

响应 Header

X-Request-IDstring

本次请求的 UUID(通用唯一识别码)。该值为本次请求 Header 中的 X-Request-ID。

  • 如果请求出错,请在日志中打印出该值,排查问题。
  • 如果本次请求的响应状态码为 401(Unauthorized),那么响应头部中无该字段。

响应 Body

statusstring

请求状态,值为 success。

请求示例

Example Request
curl --request DELETE \
  --url "https://api.sd-rtn.com/:region/v1/projects/:appId/rtls/ingress/online-streams/:sid" \
  --header 'Authorization: Basic <credentials>' \
  --header 'X-Request-ID: <string>'

响应示例

{
  "status": "请求状态,值为 `success`。"
}