# 设置全局流配置模板 (/zh-CN/api-reference/api-ref/rtmp-gateway/set-global-template)

> 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: put-region-v1-projects-appId-rtls-ingress-appconfig
- Method: PUT
- Path: /{region}/v1/projects/{appId}/rtls/ingress/appconfig
- Endpoint: https://api.sd-rtn.com/{region}/v1/projects/{appId}/rtls/ingress/appconfig

## Servers

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

:::warning[注意]
调用该接口前，必须有一个已创建的模板，可参考[创建或重置流配置模板 API](create-reset-template) 来创建模板。
:::

## 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) - 使用 RTMP 网关的区域。声网支持分区域创建推流码，目前支持以下区域：
- `cn`：中国大陆
- `ap`：除中国大陆以外的亚洲区域
- `na`：北美
- `eu`：欧洲

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

## Request body

请求包体为 JSON Object 类型的 `settings` 字段。

- `settings` (object)
  - `settings.defaultStreamTemplate` (string) - 流配置模板 ID，必须已经创建。

如果将 `defaultStreamTemplate` 的值设为 `null`，那么会清除之前为该 App ID 设置的全局流配置模板。该 App ID 下的所有推流都将按照无模板设置进行，即默认不开启视频转码。

> [!NOTE]
> 针对使用过 Beta 版本的用户：在 Beta 版本中，此 API 还可以设置 `transcoding` 转码参数，现在建议你改用[创建或重置流配置模板 API](create-reset-template) 设置。

> [!CAUTION]
> 如果你之前使用此 API 设置过 `transcoding`，目前的生效机制如下：
>   - 如果现在重新设置 `defaultStreamTemplate`，那么之前通过此 API 设置的 `transcoding` 就会自动失效，以新模板中的参数为准。
>   - 如果现在不设置新的 `defaultStreamTemplate`，那么之前通过此 API 设置的 `transcoding` 仍会保留，作为此 App ID 的默认全局配置参数。

## Responses

### default

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

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

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

- `status` (string) - 请求状态，值为 `success`。

## Response examples

### default

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

```json
{
  "status": "success"
}
```