查询频道内 Converter
更新时间不可用
查询指定频道内所有 Converter 的信息。
https://api.sd-rtn.com/v1/projects/{appId}/channels/{cname}/rtmp-converters鉴权
appIdstring声网为每个开发者提供的 App ID。在声网控制台创建一个项目后即可得到一个 App ID。一个 App ID 是一个项目的唯一标识。
cnamestring声网频道名称，即 Converter 处理的流所属的频道的名称。字符串长度必须在 64 字节以内，支持以下字符集（共 89 个字符）：
- 所有小写英文字母（a-z）
- 所有大写英文字母（A-Z）
- 数字 0-9
- 空格
- "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ","
cursornumber游标，用于分页查询 Converter 信息。取值必须大于或等于 0。
首次发起 List 请求时，无需设置 cursor 参数，请求成功后返回第一页的 Converter 信息。每次请求最多返回 500 条 Converter 信息。推荐你根据响应 Body 判断是否需要再次发起请求：
- 如果响应 Body 中的
cursor为 0，那么表示已经查询到所有 Converter 信息，无需再次发起请求。 - 如果响应 Body 中的
cursor不为 0，那么表示你的 Converter 超过 500 个，你需要再次发起请求继续查询。举例来说，首次发起请求时，不设置cursor参数，返回的响应包体中cursor假设为 3009；再次发起请求，设置cursor参数为 3009；以此类推设置cursor参数并循环请求，直到响应包体中cursor为 0 才停止请求。
Content-Typestringapplication/json
X-Request-IDstringUUID（通用唯一识别码），标识本次请求。推荐你赋值，赋值后，声网服务器会在响应 Header 中返回一个对应的 X-Custom-Request-ID 字段，你可以用此进行问题排查。如果你不赋值，那么声网服务器会自动生成一个 UUID 并在响应 Header 中返回一个对应的 X-Request-ID 字段。
响应
如果状态码为 2XX，请求成功。
响应 Header
响应 Body
successboolean请求是否成功：
true：成功。false：不成功。
total_countnumber查询到的所有 Converter 的数量。
cursornumber游标，用于对 Converter 信息列表进行分页。值为 0 表示已查询到所有 Converter，否则需要继续查询。
rtcChannelstring声网频道名称，即 Converter 处理的流所属频道的名称。
statusstring当前请求状态。
converterNamestringConverter 的名称。
updateTsstring最近一次更新 Converter 配置时的 Unix 时间戳（秒）。
appIdstring声网为每个开发者提供的 App ID。一个 App ID 是一个项目的唯一标识。
rtmpUrlstringCDN 推流地址。
converterIdstringConverter 的 ID，是声网服务器生成的一个 UUID（通用唯一识别码），标识一个已创建的 Converter。
createstring创建 Converter 时的 Unix 时间戳（秒）。
idleTimeoutstringConverter 处于空闲状态的最大时长（秒）。空闲指 Converter 处理的音视频流所对应的所有用户均已离开频道。当 Converter 处于空闲状态时长大于 idleTimeout，Converter 自动销毁，推流停止。
statestringConverter 的运行状态：
"connecting": 正在连接声网推流服务器和 CDN 服务器。"running": 正在进行推流。"failed": 推流失败。
请求示例
curl --request GET \
--url "https://api.sd-rtn.com/v1/projects/:appId/channels/:cname/rtmp-converters" \
--header 'Authorization: Basic <credentials>' \
--header 'Content-Type: <string>' \
--header 'X-Request-ID: <string>'响应示例
{
"success": true,
"data": {
"total_count": 0,
"cursor": 0,
"members": [
{
"rtcChannel": "声网频道名称，即 Converter 处理的流所属频道的名称。",
"status": "当前请求状态。",
"converterName": "Converter 的名称。",
"updateTs": "最近一次更新 Converter 配置时的 Unix 时间戳（秒）。",
"appId": "声网为每个开发者提供的 App ID。一个 App ID 是一个项目的唯一标识。",
"rtmpUrl": "CDN 推流地址。",
"converterId": "Converter 的 ID，是声网服务器生成的一个 UUID（通用唯一识别码），标识一个已创建的 Converter。",
"create": "创建 Converter 时的 Unix 时间戳（秒）。",
"idleTimeout": "Converter 处于空闲状态的最大时长（秒）。空闲指 Converter 处理的音视频流所对应的所有用户均已离开频道。当 Converter 处于空闲状态时长大于 `idleTimeout`，Converter 自动销毁，推流停止。",
"state": "Converter 的运行状态：\n- `\"connecting\"`: 正在连接声网推流服务器和 CDN 服务器。\n- `\"running\"`: 正在进行推流。\n- `\"failed\"`: 推流失败。"
}
]
}
}