列出指定 App ID 下所有推流码
更新时间不可用
分页列出指定 App ID 下的推流码。
GET
https://api.sd-rtn.com/{region}/v1/projects/{appId}/rtls/ingress/streamkeys鉴权
appIdstring必填
声网为每个开发者提供的 App ID。在声网控制台创建一个项目后即可得到一个 App ID。App ID 是一个项目的唯一标识。
regionstring必填
创建推流码的区域。声网支持分区域创建推流码,目前支持以下区域:
cn:中国大陆ap:除中国大陆以外的亚洲区域na:北美eu:欧洲
注意
- 请确保设置的
region与输入的源流在同一个区域。 - 请确保设置的
region与推流使用的域名在同一个区域。 - 请确保传入
region的值为小写。
limitstring指定每次查询最多返回的数据条目数,默认值为 20,最大值为 50。如果大于 50,则按 50 来执行查询。
cursorstring指定本次查询的起始位置。通过上一次查询返回的结果获取本次查询的 cursor 值。默认值为空,适用于分页查询的首次查询。
X-Request-IDstring本次请求的 UUID(通用唯一识别码)。传入该字段后,声网服务器会在响应 Header 中返回该字段。声网推荐你对 X-Request-ID 赋值。如果不赋值,声网服务器会自动生成一个 UUID 传入。
响应
如果状态码为 2XX,则请求成功。
响应 Body
statusstring请求状态,值为 success。
hasMoreboolean表示是否有更多数据未返回。如果为 true,则需要执行下一次请求。
包含本次返回的推流码信息列表。每个数组元素为 Object 型,包含下列字段:
streamKeystring返回的推流码。
channelstring推流码绑定的声网频道名称。
uidstring推流码绑定的声网频道内的用户 UID。
expiresAfternumber推流码的有效时长,从创建时开始计算,单位为秒。
createdAtstring推流码创建的 Unix 时间戳,单位为秒。
cursorstring下次查询时的起始位置值。
注意
请根据 hasMore 字段决定是否需要进行下一次查询,而不是仅依据 cursor 字段是否为空。
请求示例
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,则请求失败。你可以参考响应状态码了解可能的原因。