接口功能介绍
获取内网 DNS 绑定的标签
接口约束
URI
GET /v4/private-zone/list-labels
请求参数
Query 参数
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| regionID | String | 是 | 区域ID | 81f7728662dd11ec810800155d307d5b |
| zoneID | String | 是 | 内网 DNS ID | zone-r5i4zghgvq |
| pageNo | Integer | 否 | 列表的页码，默认值为 1, 推荐使用该字段, pageNumber 后续会废弃 | 1 |
| pageSize | Integer | 否 | 分页查询时每页的行数，最大值为 50，默认值为 10。 | 10 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 |
| message | String | statusCode为900时的错误信息; statusCode为800时为success, 英文 | success |
| description | String | statusCode为900时的错误信息; statusCode为800时为成功, 中文 | 成功 |
| errorCode | String | statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS | SUCCESS |
| totalCount | Integer | 列表条目数 | 20 |
| currentCount | Integer | 分页查询时每页的行数。 | 4 |
| totalPage | Integer | 总页数 | 5 |
| returnObj | Array of Objects | 返回结果 | 见下表 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| results | Array of Objects | 绑定的标签列表 | 见下表 |
表 results
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| labelID | String | 标签 id | aaaa |
| labelKey | String | 标签名 | test |
| labelValue | String | 标签值 | test |
请求示例
GET /v4/private-zone/list-labels?regionID=81f7728662dd11ec810800155d307d5b&zoneID=zone-r5i4zghgvq
请求体Body
无
响应示例
{
"statusCode": 800,
"message": "success",
"description": "成功",
"errorCode": "SUCCESS",
"returnObj": {
"currentCount": 1,
"totalCount": 1,
"totalPage": 1,
"results": [{
"labelID": "aaa",
"labelKey": "test",
"labelValue": "test"
}]
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
