删除流配置模板

更新时间不可用

删除指定的流配置模板。

DELETE
https://api.sd-rtn.com/{region}/v1/projects/{appId}/rtls/ingress/stream-templates/{templateId}

注意

  • 删除后,当前正在使用该模板推送的流不受影响,仍然按照模板参数完成推送。删除从下一次推流开始生效(包括正常推流和断线重连)。
  • 如果删除了推流码关联的模板,则默认使用该 App ID 下的全局模板。若未配置全局模板,则推流将按照无模板设置进行,即不开启视频转码。

鉴权

Basic Auth

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

API Key

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

路径参数

regionstring
必填

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

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

注意

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

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

templateIdstring
必填

流配置模板 ID。取值只能为 a-z,A-Z,0-9,且长度不能超过 12 个字节。流配置模板 ID 的值,可根据业务场景需求设置。比如可以根据目标分辨率的不同取值为 "720p", "1080p";也可以根据不同的游戏场景取值为 "gameA","gameB" 等等。

请求 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/stream-templates/:templateId" \
  --header 'Authorization: Basic <credentials>' \
  --header 'X-Request-ID: <string>'

响应示例

{
  "message": "string"
}