查询项目下所有 Converter
List
方法:查询一个项目下所有 Converter 的信息,包括数量、名称、推流地址、状态等。
请求
Basic Auth
发送 HTTP 请求时,你需要通过 Basic HTTP 认证,并将生成的凭证填入 HTTP 请求头部的 Authorization
字段。具体生成 Authorization
字段的方法请参考实现 HTTP 基本认证。
路径参数
声网为每个开发者提供的 App ID。在声网控制台创建一个项目后即可得到一个 App ID。一个 App ID 是一个项目的唯一标识。
请求 Header
application/json
UUID(通用唯一识别码),标识本次请求。推荐你赋值,赋值后,声网服务器会在响应 Header 中返回一个对应的 X-Custom-Request-ID
字段,你可以用此进行问题排查。如果你不赋值,那么声网服务器会自动生成一个 UUID 并在响应 Header 中返回一个对应的 X-Request-ID
字段。
查询参数
游标,用于分页查询 Converter 信息。取值必须大于或等于 0。
首次发起 List 请求时,无需设置 cursor
参数,请求成功后返回第一页的 Converter 信息。每次请求最多返回 500 条 Converter 信息。推荐你根据响应 Body 判断是否需要再次发起请求:
cursor
为 0,那么表示已经查询到所有 Converter 信息,无需再次发起请求。cursor
不为 0,那么表示你的 Converter 超过 500 个,你需要再次发起请求继续查询。举例来说,首次发起请求时,不设置 cursor
参数,返回的响应包体中 cursor
假设为 3009;再次发起请求,设置 cursor
参数为 3009;以此类推设置 cursor
参数并循环请求,直到响应包体中 cursor
为 0 才停止请求。响应
如果状态码为 2XX,请求成功。
响应 Header
UUID(通用唯一识别码),标识本次请求。该值为本次请求 Header 中 X-Request-ID
。如果请求出错,请在日志中打印出该值,排查问题。如果你已在请求 Header 中对 X-Request-ID
赋值,那么你在响应中收到的参数名为 X-Custom-Request-ID
,而非 X-Request-ID
。
响应 Body
请求是否成功:
true
:成功。false
:不成功。
查询到的所有 Converter 的数量。
游标,用于对 Converter 信息列表进行分页。值为 0
表示已查询到所有 Converter,否则需要继续查询。
声网频道名称,即 Converter 处理的流所属频道的名称。
Converter 的名称。
最近一次更新 Converter 配置时的 Unix 时间戳(秒)。
声网为每个开发者提供的 App ID。一个 App ID 是一个项目的唯一标识。
CDN 推流地址。
Converter 的 ID,是声网服务器生成的一个 UUID(通用唯一识别码),标识一个已创建的 Converter。
创建 Converter 时的 Unix 时间戳(秒)。
Converter 处于空闲状态的最大时长(秒)。空闲指 Converter 处理的音视频流所对应的所有用户均已离开频道。当 Converter 处于空闲状态时长大于 idleTimeout
,Converter 自动销毁,推流停止。
Converter 的运行状态:
"connecting"
: 正在连接声网推流服务器和 CDN 服务器。"running"
: 正在进行推流。"failed"
: 推流失败。
响应 Body
描述请求失败的具体原因。
请求示例
curl --request get \
--url https://api.sd-rtn.com/v1/projects/:appId/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": "string",
"converterName": "Converter 的名称。",
"updateTs": 0,
"appId": "声网为每个开发者提供的 App ID。一个 App ID 是一个项目的唯一标识。",
"rtmpUrl": "CDN 推流地址。",
"converterId": "Converter 的 ID,是声网服务器生成的一个 UUID(通用唯一识别码),标识一个已创建的 Converter。",
"create": 0,
"idleTimeout": "Converter 处于空闲状态的最大时长(秒)。空闲指 Converter 处理的音视频流所对应的所有用户均已离开频道。当 Converter 处于空闲状态时长大于 `idleTimeout`,Converter 自动销毁,推流停止。",
"state": "Converter 的运行状态:\n- `\"connecting\"`: 正在连接声网推流服务器和 CDN 服务器。\n- `\"running\"`: 正在进行推流。\n- `\"failed\"`: 推流失败。"
}
]
}
}