查询域名列表接口
更新时间:2026-10-26
接口
本接口用于查询加速域名列表及简单配置项。
请求接口
| Method | Path | 说明 |
|---|---|---|
| POST | /v2/geo/domain?action=queryDomainsWithConfig | 查询加速域名列表 |
请求体
| 参数 | 类型 | 可选 | 说明 |
|---|---|---|---|
| siteId | Int | 可选 | 对应的站点ID。 |
| keyword | String | 可选 | 可以对域名进行关键字查询,模糊查询。 |
| status | String | 可选 | 默认为 ALL(all),查询全部域名的状态。 可选值为: • OPERATING(operating):操作中; • RUNNING(running):运行中; • STOPPED(stopped):已停止; • OVERDUE(overdue):已欠费; • BANNED (banned):已封禁。 注:不区分大小写,"RUNNING" 等同于 "running"。 |
| pageNo | Int | 可选 | 查询第几页,默认为 1。输入负数或 0 时,返回错误提示。 |
| pageSize | Int | 可选 | 一页数据最大元素个数,默认为 10。输入负数或 0 时,返回错误提示。 |
您可以根据需要,选择合适的参数作为请求体进行查询域名列表操作。
响应码
| HTTP Status Code | 说明 |
|---|---|
| 200 | 查询成功 |
| 400 | 要查询的域名请求参数无效。 |
| 403 | 该域名不属于用户,用户不可操作。 |
响应体
| 参数 | 类型 | 说明 |
|---|---|---|
| siteDomainCount | Int | 当请求参数包含 siteId 时,此字段表示当前站点总共已创建的子域名个数。 |
| planDomainQuota | Int | 当请求参数包含 siteId 时,此字段表示当前套餐的子域名额度。 |
| planDomainCount | Int | 当请求参数包含 siteId 时,此字段表示当前站点关联的套餐总共已创建的子域名个数。 |
| domains | Domain[] | 加速域名元素列表。 |
| total | Int | 响应的元素个数。 |
| pageNo | Int | 返回的是第几页数据。 |
| pageSize | Int | 一页数据最大元素个数。 |
Domain 类型如下:
| 参数 | 类型 | 是否一定存在 | 说明 |
|---|---|---|---|
| domain | String | 是 | 加速域名。 |
| siteId | Int | 是 | 站点ID。 |
| cname | String | 是 | cname信息。 |
| status | String | 是 | 加速域名状态,合法值如下: • RUNNING; • STOPPED; • OVERDUE。 |
| banStatus | String | 否 | 合法值有三类: • ADMIN:风控封禁,原因主要是内容违规等,需提工单解封; • CLOSURE:GEO管理员封禁,一般是因为有流量攻击,内部封禁进行止损,需提工单解封; • USER:掉备案封禁,用户能主动触发解封,假设备案已恢复,则解封成功。 |
| httpsEnabled | String | 是 | 加速域名的HTTPS开关状态,合法值为开和关: • ON:开启; • OFF:关闭。 |
| originConfig | OriginConfig[] | 是 | 域名使用IP/DOMAIN/BUCKET 或源站池时的源站配置,当使用负载均衡时,该项为null。 |
| originInformation | String | 是 | 域名源站地址或源站池名称或负载均衡名称。 |
| originType | String | 是 | 域名源站类型。 |
| loadBalanceId | String | 否 | 负载均衡id。 |
| originPoolId | String | 否 | 源站池id。 |
| originPools | Object<OriginPools> | 否 | 当域名使用负载均衡作为源站时的源站配置。 |
| ipv6Dispatch | Object |
是 | 加速域名是否开启 ipv6 配置。 |
OriginConfig 类型说明
(1) IP 或 域名源站类型
| 字段名称 | 类型 | 是否一定存在 | 说明 |
|---|---|---|---|
| addr | String | 是 | 源站地址。支持 IPv4、IPv6 形式的 IP 地址,或者域名,不能重复 |
| type | String | 是 | 源站类型。可选值为 “IP”、“DOMAIN” |
| host | String | 否 | 回源时使用的 host 值 |
| weight | Int | 否 | 权重,当使用源站池或负载均衡作为源站配置时存在 |
| upstreamProtocol | String | 是 | 回源协议。其合法值为:‘http’、‘https’、‘*’。 |
| httpPort | Int | 否 | http 回源端口。回源协议为 ‘*’ 时,必传。 |
| httpsPort | Int | 否 | https 回源端口。回源协议为 ‘*’ 时,必传。 |
| backup | Bool | 是 | 表示该源站为主源站,恒为false |
(2)对象存储类型
| 字段名称 | 类型 | 是否一定存在 | 说明 |
|---|---|---|---|
| addr | String | 是 | BOS 的 bucket 名称或 S3 对象存储的源站地址 |
| type | String | 是 | 源站类型。可选值为 “BUCKET”、“DOMAIN”,BOS 使用 “BUCKET”,S3 使用 “DOMAIN” |
| host | String | 否 | 回源时使用的 host 值 |
| weight | Int | 否 | 权重,当使用源站池或负载均衡作为源站配置时存在 |
| upstreamProtocol | String | 是 | 回源协议。其合法值为:‘http’、‘https’、‘*’。 |
| httpPort | Int | 否 | http 回源端口。回源协议为 ‘*’ 时,必传。 |
| httpsPort | Int | 否 | https 回源端口。回源协议为 ‘*’ 时,必传。 |
| backup | Bool | 是 | 表示该源站为主源站,恒为false |
| 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 这几个字段创建时无需传值。
- 关于“无需设置”:指该字段无效,即使在配置中设置了值,也不会生效。
OriginPools 类型说明
| 字段名称 | 类型 | 是否一定存在 | 说明 |
|---|---|---|---|
| origins | Origins[] | 是 | 负载均衡的源站数组 |
| dispatchMode | String | 是 | 负载均衡策略 |
| sessionMode | String | 是 | 会话保持 |
| detectConfig | Obeject<DetectConfig> | 是 | 健康探测配置 |
| fallbackOriginConfig | FallbackOriginConfig[] | 是 | 兜底源站池源站配置,未配置时为空数组 |
Origins 类型说明
| 字段名称 | 类型 | 是否一定存在 | 说明 |
|---|---|---|---|
| originConfig | OriginConfig[] | 是 | 负载均衡的源站配置 |
| originPoolWeight | Int | 否 | 当负载均衡策略为加权轮询时存在,其值代表各源站池权重 |
DetectConfig 类型说明
| 字段名称 | 类型 | 是否一定存在 | 说明 |
|---|---|---|---|
| healthCheckType | String | 否 | 健康探测类型 |
| probeInterval | Int | 是 | 探测间隔 |
| probeMinSuccesses | Int | 是 | 健康阈值,探测最小成功阈值,与探测最大失败阈值保持一致 |
| probeMaxFails | Int | 是 | 健康阈值,探测最大失败阈值,与探测探测最小成功阈值保持一致 |
| probeTimeout | Int | 是 | 探测超时时间 |
| probeSucceedCode | String | 否 | 预期状态码。当健康探测类型为 HTTPS/HTTP 时存在 |
| probeUrl | String | 否 | 探测路径,当健康探测类型为 HTTPS/HTTP 时存在 |
| probeMethod | String | 否 | 探测请求方法,当健康探测类型为 HTTPS/HTTP 时存在 |
| checkData | String | 否 | 探测请求内容。当健康探测类型为 UDP 时存在 |
| checkResult | String | 否 | 探测返回结果。当健康探测类型为 UDP 时可能存在 |
FallbackOriginConfig 类型说明
同OriginConfig 类型说明一致。
Ipv6Dispatch 类型说明
| 字段名称 | 类型 | 是否一定存在 | 说明 |
|---|---|---|---|
| enable | String | 是 | 'enable' 为 'ON' 表示开启;'enable' 为 'OFF' 表示关闭。 |
请求示例1:无请求体参数
Plain Text
1POST /v2/geo/domain?action=queryDomainsWithConfig 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}
响应示例
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 "domains":[
10 {
11 "domain": "1.test.com",
12 "siteId": 1,
13 "cname": "1.test.com.a.bdydns.com",
14 "status": "RUNNING",
15 "cnameStatus": 0,
16 "ipv6Dispatch": {
17 "enable": "ON"
18 },
19 "originConfig": [
20 {
21 "addr": "1.2.3.4",
22 "type": "IP",
23 "host": "test.host.com",
24 "httpPort": 80,
25 "backup": false,
26 "upstreamProtocol": "http"
27 }
28 ],
29 "originInformation": "1.2.3.4",
30 "originType": "IP/DOMAIN",
31 "httpsEnabled": "OFF"
32 }
33 ],
34 "pageNo": 1,
35 "pageSize": 10
36}
请求示例2:站点ID参数
Plain Text
1POST /v2/geo/domain?action=queryDomainsWithConfig 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 "siteId":1
10}
响应示例1:IP/DOMAIN 类型源站
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 "domains":[
10 {
11 "domain": "1.test.com",
12 "siteId": 1,
13 "cname": "1.test.com.a.bdydns.com",
14 "status": "RUNNING",
15 "cnameStatus": 0,
16 "ipv6Dispatch": {
17 "enable": "ON"
18 },
19 "originConfig": [
20 {
21 "addr": "1.2.3.4", // 域名类型源站,此时为域名
22 "type": "IP",
23 "host": "test.host.com",
24 "httpPort": 80,
25 "backup": false,
26 "upstreamProtocol": "http"
27 }
28 ],
29 "httpsEnabled": "OFF"
30 }
31 ],
32 "pageNo": 1,
33 "pageSize": 10,
34 "siteDomainCount": 1,
35 "planDomainQuota": 1,
36 "planDomainCount": 1
37}
响应示例2:对象存储类型源站
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 "domains":[
10 {
11 "domain": "1.test.com",
12 "siteId": 1,
13 "cname": "1.test.com.a.bdydns.com",
14 "status": "RUNNING",
15 "cnameStatus": 0,
16 "ipv6Dispatch": {
17 "enable": "ON"
18 },
19 "originConfig": [
20 {
21 "addr": "your_bucket_addr",
22 "type": "BUCKET",
23 "thirdBucketAuth": {
24 "authType": "bos",
25 "enabled": false
26 },
27 "host": "test.host.com",
28 "backup": false,
29 "upstreamProtocol": "http"
30 }
31 ],
32 "originInformation": "your_bucket_addr",
33 "originType": "BUCKET",
34 "httpsEnabled": "OFF"
35 }
36 ],
37 "pageNo": 1,
38 "pageSize": 10,
39 "siteDomainCount": 1,
40 "planDomainQuota": 1,
41 "planDomainCount": 1
42}
响应示例3:源站池类型源站
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 "domains":[
10 {
11 "domain": "1.test.com",
12 "siteId": 1,
13 "cname": "1.test.com.a.bdydns.com",
14 "status": "RUNNING",
15 "cnameStatus": 0,
16 "ipv6Dispatch": {
17 "enable": "ON"
18 },
19 "originConfig": [
20 {
21 "addr": "test.eo.com",
22 "weight": 100,
23 "type": "IP",
24 "host": "test.host.com",
25 "backup": false,
26 "httpsPort": 40,
27 "upstreamProtocol": "https"
28 },
29 {
30 "addr": "1.2.3.4",
31 "weight": 45,
32 "type": "IP",
33 "host": "test.host.com",
34 "backup": false,
35 "httpsPort": 40,
36 "upstreamProtocol": "https"
37 }
38 ],
39 "originInformation": "originPoolName",
40 "originType": "OriginPool",
41 "originPoolId": "geo_mnPNyDml7y00",
42 "httpsEnabled": "OFF"
43 }
44 ],
45 "pageNo": 1,
46 "pageSize": 10,
47 "siteDomainCount": 1,
48 "planDomainQuota": 1,
49 "planDomainCount": 1
50}
响应示例4:负载均衡类型源站
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 "domains":[
10 {
11 "domain": "1.test.com",
12 "siteId": 1,
13 "cname": "1.test.com.a.bdydns.com",
14 "status": "RUNNING",
15 "cnameStatus": 0,
16 "ipv6Dispatch": {
17 "enable": "ON"
18 },
19 "originConfig": null,
20 "originInformation": "loadBalanceName",
21 "originType": "LoadBalance",
22 "loadBalanceId": "eo_lb_aDuhCm4ly1KD",
23 "originPools": {
24 "origins": [
25 {
26 "originPoolWeight": 1,
27 "originConfig": [
28 {
29 "addr": "1.2.3.4",
30 "weight": 50,
31 "type": "IP",
32 "backup": false,
33 "upstreamProtocol": "http",
34 "httpPort": 80
35 },
36 {
37 "addr": "test.eo.com",
38 "weight": 50,
39 "type": "DOMAIN",
40 "backup": false,
41 "upstreamProtocol": "http",
42 "httpPort": 80
43 }
44 ]
45 },
46 {
47 "originPoolWeight": 99,
48 "originConfig": [
49 {
50 "addr": "1.2.3.5",
51 "weight": 50,
52 "type": "IP",
53 "backup": false,
54 "upstreamProtocol": "http",
55 "httpPort": 80
56 },
57 {
58 "addr": "test.eo2.com",
59 "weight": 50,
60 "type": "DOMAIN",
61 "backup": false,
62 "upstreamProtocol": "http",
63 "httpPort": 80
64 }
65 ]
66 }
67 ],
68 "dispatchMode": "weight_mode",
69 "sessionMode": "OFF",
70 "detectConfig": {
71 "healthCheckType": "HTTPS",
72 "probeInterval": 60,
73 "probeMinSuccesses": 1,
74 "probeMaxFails": 1,
75 "probeTimeout": 3,
76 "probeUrl": "/testa/1.js",
77 "probeSucceedCode": "2xx",
78 "probeMethod": "GET"
79 },
80 "fallbackOriginConfig": [
81 {
82 "addr": "1.2.3.5",
83 "type": "IP",
84 "weight": 50,
85 "backup": false,
86 "upstreamProtocol": "http",
87 "httpPort": 80
88 }
89 ]
90 },
91 "httpsEnabled": "OFF"
92 }
93 ],
94 "pageNo": 1,
95 "pageSize": 10,
96 "siteDomainCount": 1,
97 "planDomainQuota": 1,
98 "planDomainCount": 1
99}
评价此篇文章
