查询域名列表接口
更新时间：2025-12-11
接口
本接口用于查询加速域名列表及简单配置项。
请求接口
| 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[] | 是 | 域名源站信息。 |
| ipv6Dispatch | String[] | 是 | 加速域名是否开启 ipv6 配置。开启，'enable' 为 'ON',关闭，'enable' 为 'OFF'。 |
OriginConfig 类型如下：
| 参数 | 类型 | 参数是否一定存在 | 说明 |
|---|---|---|---|
| type | String | 是 | 源站地址的类型，有三种： • IP • DOMAIN • BUCKET |
| addr | String | 是 | 源站地址，可以为 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。 |
请求示例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.1.1.1",
22 "type": "IP",
23 "httpPort": 80
24 }
25 ],
26 "httpsEnabled": "OFF"
27 }
28 ],
29 "pageNo": 1,
30 "pageSize": 10
31}请求示例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":"test.com"
10}响应示例
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.1.1.1",
22 "type": "IP",
23 "httpPort": 80
24 }
25 ],
26 "httpsEnabled": "OFF"
27 }
28 ],
29 "pageNo": 1,
30 "pageSize": 10,
31 "siteDomainCount": 1,
32 "planDomainQuota": 1,
33 "planDomainCount": 1
34}评价此篇文章