更新域名配置接口
更新时间：2025-12-11
接口
本接口用于更新加速域名配置。
请求接口
| Method | Path | 说明 |
|---|---|---|
| POST | /v2/geo/domain/config?action=update | 更新加速域名配置 |
请求体
| 参数 | 类型 | 可选 | 说明 |
|---|---|---|---|
| domain | String | 可选 | GEO 站点对应的加速域名，优先级高于 domains。 |
| domains | String[] | 可选 | 批量配置的域名。 |
| config | Config | 必选 | 将要更新的配置信息。 |
Config 类型如下：
| 参数 | 类型 | 可选 | 说明 |
|---|---|---|---|
| originConfig | OriginConfig[] | 必选 | 源站列表。 |
| ipv6Dispatch | String[] | 可选 | ipv6 开关。开启时为 {"enable": "ON"},关闭时为 {"enable": "OFF"}。ipv6配置仅支持单域名修改。 |
| originProtocol | String | 可选 | 回源使用的协议，默认为协议跟随回源，其合法值为三种： • http：强制使用 HTTP 协议回源; • https：强制使用 HTTPS 协议回源； • *：根据客户端的请求协议跟随回源。 |
| certId | String | 可选 | 证书ID。 |
| httpsEnabled | String | 可选 | https 开关。开启为"ON"，关闭为"OFF"。开启时必须传证书ID。 |
该接口仅支持控制台可修改的配置项，您可以根据需要，选择合适的参数作为请求体来更新域名配置。
OriginConfig 类型如下：
| 参数 | 类型 | 可选 | 说明 |
|---|---|---|---|
| type | String | 必选 | 源站地址的类型，有三种： • IP • DOMAIN • BUCKET |
| addr | String | 必选 | 源站地址，可以为 IP 或者域名格式，不能携带端口。如果为IPv6地址，请不要带上中括号。不支持CIDR格式的IP。 合法地址示例： • 1.1.1.1 • origin.com • 1::1 • a.bj.bcebos.com 非法地址示例： • ()sdas.com • 1.1.1.1:80 |
| httpPort | Int | 可选 | 源站 HTTP 服务的端口，默认值为 80。 |
| httpsPort | Int | 可选 | 源站 HTTPS 服务的端口，默认值为 443。 |
响应码
| HTTP Status Code | 说明 |
|---|---|
| 200 | 修改成功 |
| 400 | 要修改的域名请求参数无效。 |
| 403 | 该域名不属于用户，用户无法操作。 |
响应体
| 参数 | 类型 | 说明 |
|---|---|---|
| status | String | 操作的结果，当前有效值为： • OK：操作全部成功; • PartialFailed：部分成功。 |
| total | Int | 需要操作的域名数目。 |
| success | Int | 操作成功的域名数目。 |
| errMsg | String | 当 status 不为 OK 时，此字段表示错误详情。 |
请求示例
Plain Text
1POST /v2/geo/domain/config?action=update HTTP/1.1
2Host: geo.baidubce.com
3Content-Length: 46
4Authorization: xxx
5Content-Type: application/json;charset=utf-8
6Accept-Encoding: gzip
7
8{
9 "domain":"1.test.com",
10 "config": {
11 "originConfig": [
12 {
13 "type":"IP",
14 "addr":"1.1.1.1"
15 }
16 ]
17 }
18}响应示例
Plain Text
1HTTP/1.1 200 OK
2Server: nginx/1.16.1
3Content-Type: application/json; charset=utf-8
4Transfer-Encoding: chunked
5Connection: keep-alive
6
7{
8 "total":1,
9 "success":1,
10 "status":"OK"
11}评价此篇文章