查询域名列表
更新时间:2026-09-20
该接口用于分页查询服务域名,支持按服务、关键字和绑定状态筛选,并可选择是否包含系统默认域名。
请求结构
Plain Text
1POST /?action=DescribeServiceDomainsByPage HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "keyword": keyword,
7 "keywordType": keywordType,
8 "pageNo": pageNo,
9 "pageSize": pageSize,
10 "order": order,
11 "orderBy": orderBy,
12 "orders" : [order],
13 "filters" : [filter],
14 "serviceId": serviceId,
15 "searchContent": searchContent,
16 "containsSystem": containsSystem,
17 "filterBindingStatus": filterBindingStatus
18}
请求头域
除公共头域外,无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| keyword | String | 否 | RequestBody参数 | 搜索关键词 |
| keywordType | String | 否 | RequestBody参数 | 关键词类型 |
| pageNo | int | 否 | RequestBody参数 | 页码,从 1 开始 |
| pageSize | int | 否 | RequestBody参数 | 每页返回的记录数 |
| order | String | 否 | RequestBody参数 | 排序方向 |
| orderBy | String | 否 | RequestBody参数 | 排序字段 |
| orders | List<OrderModel> | 否 | RequestBody参数 | 多字段排序设置 |
| filters | List<FilterModel> | 否 | RequestBody参数 | 筛选条件 |
| serviceId | String | 否 | RequestBody参数 | 服务 ID |
| searchContent | String | 否 | RequestBody参数 | 搜索内容,按域名或服务域名 ID 前缀匹配 |
| containsSystem | Boolean | 否 | RequestBody参数 | 是否包含系统默认域名;true:包含,false 或不传:仅返回自定义域名 |
| filterBindingStatus | Boolean | 否 | RequestBody参数 | 绑定状态筛选;true:已绑定,false:未绑定,不传:不过滤 |
返回头域
除公共头域,无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| orderBy | String | 排序字段 |
| order | String | 排序方向 |
| pageNo | int | 页码,从 1 开始 |
| pageSize | int | 每页返回的记录数 |
| totalCount | long | 符合条件的记录总数 |
| result | List<ListAiGwServiceDomainUO> | 当前页的服务域名列表 |
错误码
| 错误码 | 错误描述 | HTTP状态码 | 中文解释 |
|---|---|---|---|
| MethodArgumentNotValidException | MethodArgumentNotValidException: The maximum value of maxKeys is 1000. | 400 | 必填参数缺失或格式不合法,pageNo 最小为 1,pageSize 取值范围为 1~1000 |
| HttpMessageNotReadable | Http Message Not Readable: JSON parse error | 400 | 请求体不是合法 JSON,无法解析,请检查 JSON 语法和字段类型 |
| HttpMediaTypeException | HttpMediaTypeException: Content-Type 'text/plain' is not supported | 415 | 请求的 Content-Type 不受支持,请使用 application/json |
请求示例
Plain Text
1POST /?action=DescribeServiceDomainsByPage HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048f7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4
5{
6 "pageNo": 1,
7 "pageSize": 20,
8 "serviceId": "svc-a1b2c3d4",
9 "containsSystem": true
10}
返回示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6
7{
8 "orderBy": "",
9 "order": "",
10 "pageNo": 1,
11 "pageSize": 20,
12 "totalCount": 3,
13 "result": [
14 {
15 "serviceDomainId": "dn-a1b2c3d4",
16 "domainName": "api.example.com",
17 "protocolType": "BOTH_FORCE_HTTPS",
18 "instanceId": "gw-a1b2c3d4",
19 "instanceName": "生产网关",
20 "serviceId": "svc-a1b2c3d4",
21 "serviceName": "对话服务",
22 "domainType": "custom",
23 "updateTime": "2026-09-05T10:30:00Z"
24 },
25 {
26 "serviceDomainId": "dn-i9j0k1l2",
27 "domainName": "svc-a1b2c3d4.baidubce.com",
28 "protocolType": "HTTP",
29 "instanceId": "gw-a1b2c3d4",
30 "instanceName": "生产网关",
31 "serviceId": "svc-a1b2c3d4",
32 "serviceName": "对话服务",
33 "domainType": "system_public",
34 "updateTime": "2026-09-03T08:00:00Z"
35 },
36 {
37 "serviceDomainId": "dn-m3n4o5p6",
38 "domainName": "svc-a1b2c3d4.internal.baidubce.com",
39 "protocolType": "HTTP",
40 "instanceId": "gw-a1b2c3d4",
41 "instanceName": "生产网关",
42 "serviceId": "svc-a1b2c3d4",
43 "serviceName": "对话服务",
44 "domainType": "system_private",
45 "updateTime": "2026-09-03T08:00:00Z"
46 }
47 ]
48}
评价此篇文章
