更新域名配置接口
更新时间:2026-10-15
接口
本接口用于更新加速域名配置。
请求接口
| Method | Path | 说明 |
|---|---|---|
| POST | /v2/geo/domain/config?action=update | 更新加速域名配置 |
请求体
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| site | String | 是 | 域名所属站点。 |
| domain | String | 否 | EO 站点对应的加速域名,优先级高于 domains。 |
| domains | String[] | 否 | 批量配置的域名。批量配置仅支持证书配置。 |
| config | Config | 是 | 将要更新的配置信息。 |
Config 类型如下:
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| originConfig | Array<OriginConfig> | 否 | 源站配置。 |
| originPoolId | String | 否 | 源站池id。表示域名使用源站池作为源站配置。 |
| upstreamProtocol | String | 否 | 回源协议。其合法值为:‘http’、‘https’、‘*’。使用源站池或负载均衡配置时必传。 |
| ipv6Dispatch | Object<Ipv6Dispatch> | 否 | 域名的 ipv6 配置。 |
| httpPort | Int | 否 | http 回源端口。使用源站池或负载均衡配置时必传。回源协议为 ‘*’ 时,必传。 |
| httpsPort | Int | 否 | https 回源端口。使用源站池或负载均衡配置时必传。回源协议为 ‘*’ 时,必传。 |
| loadBalanceId | String | 否 | 负载均衡id。表示域名使用负载均衡作为源站配置。 |
| certId | String | 否 | 证书ID。 |
| httpsEnabled | String | 否 | https 开关。开启为"ON",关闭为"OFF"。开启时必须传证书ID。 |
OriginConfig 类型说明
(1) IP 或 域名源站类型
| 字段名称 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| addr | String | 是 | 源站地址。支持 IPv4、IPv6 形式的 IP 地址,或者域名,不能重复 |
| type | String | 是 | 源站类型。可选值为 “IP”、“DOMAIN” |
| host | String | 否 | 回源时使用的 host 值 |
| upstreamProtocol | String | 是 | 回源协议。其合法值为:‘http’、‘https’、‘*’。 |
| httpPort | Int | 否 | http 回源端口。回源协议为 ‘*’ 时,必传。 |
| httpsPort | Int | 否 | https 回源端口。回源协议为 ‘*’ 时,必传。 |
(2)对象存储类型
| 字段名称 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| addr | String | 是 | BOS 的 bucket 名称或 S3 对象存储的源站地址 |
| type | String | 是 | 源站类型。可选值为 “BUCKET”、“DOMAIN”,BOS 使用 “BUCKET”,S3 使用 “DOMAIN” |
| host | String | 否 | 回源时使用的 host 值 |
| upstreamProtocol | String | 是 | 回源协议。其合法值为:‘http’、‘https’、‘*’。 |
| httpPort | Int | 否 | http 回源端口。回源协议为 ‘*’ 时,必传。 |
| httpsPort | Int | 否 | https 回源端口。回源协议为 ‘*’ 时,必传。 |
| thirdBucketAuth | Object<ThirdBucketAuth> | 是 | 对象存储的鉴权配置 |
ThirdBucketAuth 类型说明
| 字段名称 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| authType | String | 是 | 鉴权类型,当前支持 AWS S3 以及 BOS。其合法值为:“aws_v2”、“aws_v4”、“bos” |
| enabled | Bool | 是 | 私有访问鉴权的开关,其合法值为 “true”、“false” |
| ak | String | 否 | 只针对 S3 鉴权类型生效,开启私有访问鉴权时必须输入该值,对象存储的访问密钥 Access Key |
| sk | String | 否 | 只针对 S3 鉴权类型生效,开启私有访问鉴权时必须输入该值,对象存储的私有访问密钥 Secret Access Key |
| bucket | String | 否 | 只针对 S3 鉴权类型生效,对象存储的 bucket。 • aws_v2:必须设置 • aws_v4:无需设置 |
| region | String | 否 | 只针对 S3 鉴权类型生效,对象存储的区域。 • aws_v2:无需设置 • aws_v4:选填,默认区域为 “us-east-1” |
| service | String | 否 | 只针对 S3 鉴权类型生效,对象存储的服务。 • aws_v2:无需设置 • aws_v4:选填,默认服务为 “s3” |
注:
- 每个站点最多支持创建50个源站池,每个源站池最多支持创建20个源站。
- 针对 BOS 对象存储类型:ak、sk、bucket、region、service 这几个字段创建时无需传值。
- 关于“无需设置”:指该字段无效,即使在配置中设置了值,也不会生效。
Ipv6Dispatch 类型如下:
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| enable | String | 是 | ipv6 配置开关。开启为 "ON",关闭为 "OFF"。 |
响应码
| HTTP Status Code | 说明 |
|---|---|
| 200 | 修改成功 |
| 400 | 要修改的域名请求参数无效。 |
| 403 | 该域名不属于用户,用户无法操作。 |
响应体
| 参数 | 类型 | 说明 |
|---|---|---|
| status | String | 操作的结果,当前有效值为: • OK:操作全部成功; • PartialFailed:部分成功。 |
| total | Int | 需要操作的域名数目。 |
| success | Int | 操作成功的域名数目。 |
| errMsg | String | 当 status 不为 OK 时,此字段表示错误详情。 |
请求示例1
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 "addr": "1.2.3.4",
14 "type": "IP",
15 "host": "test.host.com"
16 "httpPort": 80,
17 "upstreamProtocol": "http"
18 }
19 ],
20 "ipv6Dispatch": {
21 "enable": "ON"
22 },
23 "httpsEnabled":"ON",
24 "certId":"xxx"
25 }
26}
请求示例2
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-eo.com",
10 "config": {
11 "loadBalanceId":"eo_lb_cBDWrpmrxO0B",
12 "upstreamProtocol": "http",
13 "httpPort": 80
14 },
15 "site": "test-eo.com"
16}
请求示例3
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-eo.com",
10 "config": {
11 "originPoolId":"geo_cBDWrpmrxO0B",
12 "upstreamProtocol": "http",
13 "httpPort": 80
14 },
15 "site": "test-eo.com"
16}
响应示例
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}
评价此篇文章
