查询当前在推流列表
更新时间不可用
查询当前正在推送到 RTMP 网关的流列表。
https://api.sd-rtn.com/{region}/{version}/projects/{appId}/rtls/ingress/online-streams鉴权
regionstring创建推流码的区域。声网支持分区域创建推流码，目前支持以下区域：
cn：中国大陆ap：除中国大陆以外的亚洲区域na：北美eu：欧洲
注意
- 请确保设置的
region与输出的源流在同一个区域。 - 请确保设置的
region与推流使用的域名在同一个区域。 - 请确保传入的
region的值为小写。
versionstring查询信息的版本，可以设为 v1 或 v2。不同版本返回的结果详见响应。
appIdstring声网为每个开发者提供的 App ID。在声网控制台创建一个项目后即可得到一个 App ID。App ID 是一个项目的唯一标识。
channelstring查询在推流所在的频道名。如果指定 channel，那么只返回推往指定频道内的在线流信息。注意，因为声网频道名允许包含一些特殊字符，因此需要先进行 URL转义。
X-Request-IDstring本次请求的 UUID（通用唯一识别码）。传入该字段后，声网服务器会在响应 Header 中返回该字段。声网推荐你对 X-Request-ID 赋值。如果不赋值，声网服务器会自动生成一个 UUID 传入。
响应
如果状态码为 2XX，则请求成功。
响应 Header
响应 Body
如果请求路径中 version 填 v1，则返回如下字段。
statusstring本次请求的状态。值为 "success"。
在线流的信息组成的数组。每个元素表示一条在线流的信息。
sidstring推流会话 ID，每次推流都会生成一个唯一的 sid。
channelstring推流的目标声网频道名称。
uidstring推流使用的声网频道内的主播用户 UID。
urlstring推流的地址，格式为 {domain}/live/{streamkey}。
statusstring表示流状态，可能的值有：
"Started"：RTMP 连接已建立，等待推送音视频。"Running"：正在推流中。
beginAtstring推流开始时间，格式为 "2024-01-01 01:01:01.001"。
bitrateinteger推流的源流码率（音频+视频），单位 Kbps。
视频流参数，仅在 status 为 "Running" 时才会返回。
widthnumber视频宽，单位为 px。
heightnumber视频高，单位为 px。
fpsnumber视频帧率，单位为 fps。
音频流参数，仅在 status 为 "Running" 时才会返回。
channelsnumber音频声道数。
sampleRatenumber音频采样率，单位为 Hz。
如果请求路径中 version 填 v2，则返回如下字段。
statusstring当前请求状态，值为 "success"。
每个元素为一个 JSON Object，表示一条在线流的信息。
sidstring推流会话 ID，每次推流都会生成一个唯一的 sid。
channelstring推流的目标声网频道名称。
uidstring推流使用的声网频道内的主播用户 UID。
urlstring推流的地址，格式为 {domain}/live/{streamkey}。
statusstring流状态。可能的值有：
"Started"：RTMP 连接已建立，等待推送音视频。"Running"：正在推流中。
beginAtstring推流开始时间，格式为 "2024-01-01 01:01:01.001"。
输入流的参数。只有在 "status" 为 "Running" 时才返回。
视频流参数。只有在输入流中存在视频流才会返回。
codecstring视频编码类型，可选值 "H.264", "H.265" 等。
bitratenumber视频码率，单位 Kbps。
widthnumber视频宽度，单位为 px。
heightnumber视频高度，单位为 px。
fpsnumber视频帧率。
gopnumber视频 GOP，单位为毫秒。
音频流参数。只有在输入流中存在音频流时才返回。
codecstring音频编码类型，可选值 "AAC", "HE-AAC", "HE-AAC-V2" 等。
channelsnumber音频声道数。
sampleRatenumber音频采样率。
bitratenumber推流的源流音频码率，单位为 Kbps。
表示网关推送进大网的流参数。只有在 "status" 为 "Running" 时才返回。
视频大流参数。只有在输入流中存在视频流才会返回。
codecstring视频编码类型，可选值 "NONE", "H.264", "H.265","VP8" 等。
说明
如果 codec 值为 "None"，则表示本条流为开始视频转码或音频转码。
bitratenumber视频大流码率，单位为 Kbps。
说明
如果开启了视频转码，则 bitrate 的值为实际编码输出的码率。当画面复杂度较低时，输出码率可能低于设定的编码目标码率。原因是在保证相同画质的条件下，编码器认为不需要达到那么高的码率。
widthnumber视频大流宽度，单位为 px。
heightnumber视频大流高度，单位为 px。
fpsnumber视频大流帧率。
gopnumber视频大流 GOP，单位为毫秒。
表示视频小流参数。只有实际开启了小流才会返回。
bitratenumber视频小流码率，单位为 Kbps。
音频流参数，只有在输入流中存在音频流才会返回。
codecstring音频编码类型，可选值 "NONE", "OPUS" 等。
channelsnumber音频声道数。
sampleRatenumber音频采样率。
bitratenumber推流的源流音频码率，单位为 Kbps。
说明
如果开启了音频转码，bitrate 的值是根据源流声道数和设置的 profile 值计算所得，是编码输出的目标码率，非实际码率。通常情况下，银瀑呢输出码率会保持设定码率。
请求示例
curl --request GET \
--url "https://api.sd-rtn.com/:region/:version/projects/:appId/rtls/ingress/online-streams" \
--header 'Authorization: Basic <credentials>' \
--header 'X-Request-ID: <string>'响应示例
{
"status": "success",
"data": [
{
"sid": "eba0c189-15ab-b852-b51d-6705****00ce",
"channel": "shx1013001",
"uid": "123",
"url": "shxtest1-rtcpush-test-cn.agoramdn.com/live/pIdY42WEm5****fblM-Q8M1vMMXQ",
"status": "Running",
"beginAt": "2023-10-16 11:36:12.293",
"bitrate": 4147,
"video": {
"width": 1920,
"height": 1080,
"fps": 30
},
"audio": {
"channels": 2,
"sampleRate": 48000
}
}
]
}