接口功能介绍
内网 DNS 列表
接口约束
URI
GET /v4/private-zone/list
请求参数
Query 参数
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| clientToken | String | 否 | 客户端存根，用于保证订单幂等性, 长度 1 - 64 | 79fa97e3-c48b-xxxx-9f46-6a13d8163678 |
| regionID | string | 是 | 资源池ID | |
| zoneID | string | 否 | zoneID | zone-r5i4zghgvq |
| zoneName | string | 否 | zoneName | zone2 |
| pageNumber | Integer | 否 | 列表的页码，默认值为1。 | 1 |
| pageNo | Integer | 否 | 列表的页码，默认值为 1, 推荐使用该字段, pageNumber 后续会废弃 | 1 |
| pageSize | Integer | 否 | 分页查询时每页的行数，最大值为50，默认值为10。 | 5 |
响应参数
| 参数 | 参数类型 | 示例 | 说明 |
|---|---|---|---|
| statusCode | Integer | 800 | 返回状态码（800为成功，900为失败） |
| returnObj | Object | object | 返回结果 |
| errorCode | String | SUCCESS | 业务细分错误码，三段式：product.module.code |
| message | String | success | statusCode为900时的错误信息，英文 |
| description | String | success | statudCode为900时的错误信息，中文 |
| totalCount | Integer | 20 | 列表条目数 |
| currentCount | Integer | 4 | 分页查询时每页的行数 |
| totalPage | Integer | 5 | 总页数 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| zones | Object of Array | zoneRecord组 |
zoneRecords
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| zoneID | String | 名称 | zone-r5i4zghgvq |
| name | String | zone record名称 | record |
请求示例
GET /v4/private-zone/list?regionID=xxxx
请求体body
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "",
"returnObj": {
"zones": [
{
"zoneID": "zone-ee4gvj0sef",
"name": "wyx002.cn"
},
{
"zoneID": "zone-npszfa79q6",
"name": "wyx001.cn"
},
{
"zoneID": "zone-n6kpfpv92n",
"name": "liuyue-tmp.com"
},
{
"zoneID": "zone-4qwjsjv4gr",
"name": "ysf.dns.test.com"
}
]
},
"currentCount": 4,
"totalCount": 4,
"totalPage": 1
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
