更新网关实例
更新时间:2026-09-04
接口描述
更新 AI 网关实例的名称、描述、删除保护、公网访问、副本数、网络类型和标签。
OpenAPI Explorer
去调试
您可以在 OpenAPI Explorer 中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer 可以自动生成 SDK 代码示例。
请求结构
Plain Text
1PUT /v1/aigateway/{instanceId} HTTP/1.1
2Host: aigw.bj.baidubce.com
3X-Region: bj
4Authorization: authorization string
5Content-Type: application/json
请求头域
除公共头域外,还需传入以下头域:
| 请求头 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| X-Region | String | 是 | 地域代码,如 bj、gz、su、cd、yq、bd |
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| instanceId | String | 是 | URL参数 | 网关实例 ID |
| name | String | 否 | RequestBody参数 | 实例名称 |
| description | String | 否 | RequestBody参数 | 实例描述 |
| deleteProtection | Boolean | 否 | RequestBody参数 | 是否开启删除保护 |
| publicAccessible | Boolean | 否 | RequestBody参数 | 是否允许公网访问 |
| replicas | Integer | 否 | RequestBody参数 | 副本数,服务端校验范围为 2-5 |
| networkTypes | List |
否 | RequestBody参数 | 网络类型:private、public,可多选 |
| tags | List |
否 | RequestBody参数 | 标签列表;不传表示不修改,空数组表示清空 |
返回状态码
成功返回 200;参数错误返回 400;实例不存在返回 404;副本扩缩容失败返回对应错误码。
返回头域
除公共头域外,无其他特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| instanceId | String | 网关实例 ID |
| name | String | 更新后的名称 |
| description | String | 更新后的描述 |
| deleteProtection | Boolean | 删除保护状态 |
| publicAccessible | Boolean | 公网访问状态 |
| replicas | Integer | 更新后的副本数 |
| updateTime | String | 更新时间 |
请求示例
Plain Text
1PUT /v1/aigateway/aigw-example HTTP/1.1
2Host: aigw.bj.baidubce.com
3X-Region: bj
4Authorization: authorization string
5Content-Type: application/json
6
7{
8 "description": "更新后的网关实例",
9 "replicas": 3,
10 "deleteProtection": true
11}
返回示例
Plain Text
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3
4{
5 "instanceId": "aigw-example",
6 "name": "aigw-demo",
7 "description": "更新后的网关实例",
8 "deleteProtection": true,
9 "publicAccessible": false,
10 "replicas": 3,
11 "updateTime": "2026-09-03 12:00:00"
12}
评价此篇文章
