列出指定 App ID 下所有推流码

更新时间不可用

分页列出指定 App ID 下的推流码。

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

鉴权

Basic Auth

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

API Key

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

路径参数

appIdstring
必填

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

regionstring
必填

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

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

注意

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

指定每次查询最多返回的数据条目数,默认值为 20,最大值为 50。如果大于 50,则按 50 来执行查询。

cursorstring

指定本次查询的起始位置。通过上一次查询返回的结果获取本次查询的 cursor 值。默认值为空,适用于分页查询的首次查询。

请求 Header

X-Request-IDstring

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

响应

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

响应 Body

字段
statusstring

请求状态,值为 success。

请求示例

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

响应示例

如果状态码不为 2XX,则请求失败。你可以参考响应状态码了解可能的原因。