销毁推流码

更新时间不可用

销毁不再使用的推流码。

DELETE
https://api.sd-rtn.com/{region}/v1/projects/{appId}/rtls/ingress/streamkeys/{streamkey}

调用该接口销毁不再使用的推流码。

销毁后,你无法再使用该推流码进行推流。但如果推流码正在使用中,销毁推流码并不会影响当前正在推送的流。如果要立即禁用该条流,请搭配调用使用 SID 强制断开推流 API。

鉴权

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 是一个项目的唯一标识。

streamkeystring
必填

待销毁的推流码。

请求 Header

X-Request-IDstring

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

响应

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

响应 Header

X-Request-IDstring

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

响应 Body

statusstring

请求状态,值为 success。

请求示例

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

响应示例

{
  "message": "string"
}