接口功能介绍
内网DNS详情
接口约束
URI
GET /v4/private-zone/query
请求参数
Query 参数
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| regionID | String | 是 | 资源池ID | |
| azName | String | 否 | 可用区名称 | |
| projectID | String | 否 | 企业项目ID，默认为"0" | 0 |
| zoneID | String | 是 | zoneID | zone-r5i4zghgvq |
响应参数
| 参数 | 参数类型 | 示例 | 说明 |
|---|---|---|---|
| statusCode | Integer | 800 | 返回状态码（800为成功，900为失败） |
| returnObj | Object | object | 返回结果 |
| errorCode | String | SUCCESS | 业务细分错误码，三段式：product.module.code |
| message | String | success | statusCode为900时的错误信息，英文 |
| description | String | success | statudCode为900时的错误信息，中文 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| zoneID | String | 名称 | zone-r5i4zghgvq |
| name | String | zone名称 | example.com |
| description | String | 描述 | zone |
| proxyPattern | String | zone, record | zone |
| TTL | Integer | zone ttl, default is 300 | 300 |
| vpcAssociations | Object of Array | vpc关联信息数组 | |
| createdAt | String | 创建时间 | 2022-09-02T06:54:45Z |
| updatedAt | String | 更新时间 | 2022-09-02T06:54:45Z |
表 vpcAssociations
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| vpcAssociation | object | vpc关联信息对象 |
表 vpcAssociation
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| vpcID | String | vpc | vpc-hfw53u96ku |
| vpcName | String | vpcName | vpc-name |
请求示例
GET /v4/private-zone/query?regionID=xxxx&zoneID=xxxxx
请求体body
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "",
"returnObj": {
"zoneID": "zone-r5i4zghgvq",
"name": "example.com",
"description": "description",
"proxyPattern": "zone",
"TTL": 300,
"vpcAssociations": [{
"vpcID": "vpc-hfw53u96ku",
"vpcName": "vpc-name"
}],
"createdAt": "2022-09-02T06:54:45Z",
"updatedAt": "2022-09-02T06:54:45Z"
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
