# 查询当前在推流列表 (/zh-CN/api-reference/api-ref/rtmp-gateway/query-streaming-list)

> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).

查询当前正在推送到 RTMP 网关的流列表。

- OpenAPI: /openapi/media-gateway/media-gateway.zh-CN.yaml
- Operation ID: get-region-v1-projects-appId-rtls-ingress-online-streams
- Method: GET
- Path: /{region}/{version}/projects/{appId}/rtls/ingress/online-streams
- Endpoint: https://api.sd-rtn.com/{region}/{version}/projects/{appId}/rtls/ingress/online-streams

## Servers

- https://api.sd-rtn.com/

## Authorization

This endpoint requires authentication.

- `Basic Auth`
- `API Key`

## Parameters

- `region` (path, required, string) - 创建推流码的区域。声网支持分区域创建推流码，目前支持以下区域：
- `cn`：中国大陆
- `ap`：除中国大陆以外的亚洲区域
- `na`：北美
- `eu`：欧洲

> [!CAUTION]
> - 请确保设置的 `region` 与输出的源流在同一个区域。
> - 请确保设置的 `region` 与推流使用的域名在同一个区域。
> - 请确保传入的 `region` 的值为小写。
- `version` (path, required, string) - 查询信息的版本，可以设为 `v1` 或 `v2`。不同版本返回的结果详见**响应**。
- `appId` (path, required, string) - 声网为每个开发者提供的 App ID。在声网控制台创建一个项目后即可得到一个 App ID。App ID 是一个项目的唯一标识。
- `X-Request-ID` (header, optional, string) - 本次请求的 UUID（通用唯一识别码）。传入该字段后，声网服务器会在响应 Header 中返回该字段。声网推荐你对 `X-Request-ID` 赋值。如果不赋值，声网服务器会自动生成一个 UUID 传入。
- `channel` (query, optional, string) - 查询在推流所在的频道名。如果指定 channel，那么只返回推往指定频道内的在线流信息。注意，因为声网频道名允许包含一些特殊字符，因此需要先进行 URL转义。

## Request body

No request body.

## Responses

### 2XX

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

- `status` (string) - 本次请求的状态。值为 `"success"`。
- `data` (array) - 在线流的信息组成的数组。每个元素表示一条在线流的信息。
  - `data.items` (object)
    - `data.items.sid` (string) - 推流会话 ID，每次推流都会生成一个唯一的 `sid`。
    - `data.items.channel` (string) - 推流的目标声网频道名称。
    - `data.items.uid` (string) - 推流使用的声网频道内的主播用户 UID。
    - `data.items.url` (string) - 推流的地址，格式为 `{domain}/live/{streamkey}`。
    - `data.items.status` (string) - 表示流状态，可能的值有：
- `"Started"`：RTMP 连接已建立，等待推送音视频。
- `"Running"`：正在推流中。
    - `data.items.beginAt` (string) - 推流开始时间，格式为 `"2024-01-01 01:01:01.001"`。
    - `data.items.bitrate` (integer) - 推流的源流码率（音频+视频），单位 Kbps。
    - `data.items.video` (object) - 视频流参数，仅在 `status` 为 `"Running"` 时才会返回。
      - `data.items.video.width` (number) - 视频宽，单位为 px。
      - `data.items.video.height` (number) - 视频高，单位为 px。
      - `data.items.video.fps` (number) - 视频帧率，单位为 fps。
    - `data.items.audio` (object) - 音频流参数，仅在 `status` 为 `"Running"` 时才会返回。
      - `data.items.audio.channels` (number) - 音频声道数。
      - `data.items.audio.sampleRate` (number) - 音频采样率，单位为 Hz。
### default

如果状态码不为 `2XX`，则请求失败。你可以参考[响应状态码](/zh-CN/realtime-media/rtmp-gateway/reference/response-code)了解可能的原因。

- `message` (string) - 请求失败的具体原因。

## Response examples

### 2XX

```json
{
  "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
      }
    }
  ]
}
```
### default

```json
{
  "message": "string"
}
```