# 查询推流码信息 (/zh-CN/api-reference/api-ref/rtmp-gateway/query-streaming-key)

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

查询指定推流码绑定的频道、UID 和有效期等信息。

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

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

> [!CAUTION]
> - 请确保设置的 `region` 与输入的源流在同一个区域。
> - 请确保设置的 `region` 与推流使用的域名在同一个区域。
> - 请确保传入 `region` 的值为小写。
- `appId` (path, required, string) - 声网为每个开发者提供的 App ID。在声网控制台创建一个项目后即可得到一个 App ID。App ID 是一个项目的唯一标识。
- `streamkey` (path, required, string) - 要查询的推流码。

## Request body

No request body.

## Responses

### default

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

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

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

- `status` (string) - 请求状态，值为 `success`。
- `data` (object)
  - `data.streamKey` (string) - 新创建的推流码。
  - `data.channel` (string) - 推流码绑定的声网频道名称。
  - `data.uid` (string) - 推流码绑定的声网频道内的用户 UID。
  - `data.expiresAfter` (integer) - 推流码的有效时长，从创建时开始计算，单位为秒。
  - `data.createdAt` (string) - 推流码创建时的 Unix 时间戳，单位为秒。

## Response examples

### default

```json
{
  "message": "string"
}
```
### 2XX

```json
{
  "status": "success",
  "data": {
    "streamKey": "2dfMTR****fys",
    "channel": "shx001",
    "uid": "1001",
    "expiresAfter": 0,
    "createdAt": "1686820170"
  }
}
```