# 列出指定 App ID 下所有推流码 (/zh-CN/api-reference/api-ref/rtmp-gateway/list-streaming-keys)

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

分页列出指定 App ID 下的推流码。

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

## Servers

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

## Authorization

This endpoint requires authentication.

- `Basic Auth`
- `API Key`

## Parameters

- `X-Request-ID` (header, optional, string) - 本次请求的 UUID（通用唯一识别码）。传入该字段后，声网服务器会在响应 Header 中返回该字段。声网推荐你对 `X-Request-ID` 赋值。如果不赋值，声网服务器会自动生成一个 UUID 传入。
- `appId` (path, required, string) - 声网为每个开发者提供的 App ID。在声网控制台创建一个项目后即可得到一个 App ID。App ID 是一个项目的唯一标识。
- `region` (path, required, string) - 创建推流码的区域。声网支持分区域创建推流码，目前支持以下区域：
- `cn`：中国大陆
- `ap`：除中国大陆以外的亚洲区域
- `na`：北美
- `eu`：欧洲

> [!CAUTION]
> - 请确保设置的 `region` 与输入的源流在同一个区域。
> - 请确保设置的 `region` 与推流使用的域名在同一个区域。
> - 请确保传入 `region` 的值为小写。
- `limit` (path, optional, string) - 指定每次查询最多返回的数据条目数，默认值为 20，最大值为 50。如果大于 50，则按 50 来执行查询。
- `cursor` (path, optional, string) - 指定本次查询的起始位置。通过上一次查询返回的结果获取本次查询的 `cursor` 值。默认值为空，适用于分页查询的首次查询。

## Request body

No request body.

## Responses

### default

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

No schema.
### 2XX

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

- `status` (string) - 请求状态，值为 `success`。
- `data` (object)
  - `data.hasMore` (boolean) - 表示是否有更多数据未返回。如果为 `true`，则需要执行下一次请求。
  - `data.streamKeys` (array) - 包含本次返回的推流码信息列表。每个数组元素为 Object 型，包含下列字段：
    - `data.streamKeys.items` (object)
      - `data.streamKeys.items.streamKey` (string) - 返回的推流码。
      - `data.streamKeys.items.channel` (string) - 推流码绑定的声网频道名称。
      - `data.streamKeys.items.uid` (string) - 推流码绑定的声网频道内的用户 UID。
      - `data.streamKeys.items.expiresAfter` (number) - 推流码的有效时长，从创建时开始计算，单位为秒。
      - `data.streamKeys.items.createdAt` (string) - 推流码创建的 Unix 时间戳，单位为秒。
  - `data.cursor` (string) - 下次查询时的起始位置值。

> [!CAUTION]
> 请根据 `hasMore` 字段决定是否需要进行下一次查询，而不是仅依据 `cursor` 字段是否为空。

## Response examples

### 2XX

```json
{
  "status": "success",
  "data": {
    "hasMore": false,
    "streamKeys": [
      {
        "streamKey": "2waAf2n****JSXpJQ",
        "channel": "test001",
        "uid": "100",
        "expiresAfter": 0,
        "createdAt": "1714297679"
      }
    ],
    "cursor": "662e1****72e026"
  }
}
```