查詢IPv6列表
更新時間 2023-07-19 13:57:29
最近更新時間: 2023-07-19 13:57:29
分享文章
接口功能介紹
調用此接口可查詢 IPv6 列表。
接口約束
無。
URI
GET /v4/ipv6/ipv6-list
請求參數
Query 參數
| 參數 | 參數類型 | 是否必選 | 說明 | 示例 |
|---|---|---|---|---|
| regionID | String | 是 | 資源池ID | |
| vpcID | sting | 否 | vpc id | |
| subnetID | String | 否 | 子網id | |
| ipAddress | String | 否 | ipv6地址 | |
| page | Integer | 否 | 分頁參數 | 1 |
| pageNo | Integer | 否 | 列表的頁碼，默認值為 1, 推薦使用該字段, page 后續會廢棄 | 1 |
| pageSize | Integer | 否 | 每頁數據量大小，取值1-50 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 |
|---|---|---|---|
| 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 |
| returnObj | Object | 業務數據 | 見下表 |
| totalCount | Integer | 列表條目數 | 20 |
| currentCount | Integer | 分頁查詢時每頁的行數。 | 4 |
| totalPage | Integer | 總頁數 | 5 |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 |
|---|---|---|---|
| ipv6s | Array of Objects | IPv6 列表 | 見下表 |
表 ipv6s
| 參數 | 參數類型 | 說明 | 示例 |
|---|---|---|---|
| ID | String | ipv6 id | |
| vpcID | sting | vpc id | |
| subnetID | String | 子網id | |
| ipAddress | String | ipv6地址 | |
| associationID | String | 綁定實例的id | |
| associationType | int | 綁定實例類型 0: port, 1:ha_vip, 2:elb | |
| bandwidthID | int | 公網帶寬id | |
| createdAt | time | 創建時間 | |
| updatedAt | time | 更新時間 |
請求示例
GET /v4/ipv6/ipv6-list?regionID=xxxx
請求體body
響應示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": {
"ipv6s": [
{
"ID": "ipv6-zkuai8d2vv",
"vpcID": "vpc-5xyj41ft5b",
"ipAddress": "100:0:9:0:3d:724f:1:a937",
"associationID": "port-9kryefoc48",
"associationType": 0,
"subnetID": "subnet-qiu06n0k7y",
"bandwithID": "",
"createdAt": "2022-03-23T02:42:09Z",
"updatedAt": "2022-03-23T02:42:09Z"
}
],
"currentCount": 1,
"totalCount": 20,
"totalPage": 20
}
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 表示請求成功。 |
錯誤碼
請參考 錯誤碼說明。
