查看 IPv6 帶寬列表
更新時間 2023-07-19 13:57:29
最近更新時間: 2023-07-19 13:57:29
分享文章
接口功能介紹
查看 IPv6 帶寬列表。
接口約束
無。
URI
GET /v4/ipv6_bandwidth/list
請求參數
Query 參數
| 參數 | 參數類型 | 是否必填 | 說明 | 示例 |
|---|---|---|---|---|
| regionID | String | 是 | 資源池 ID | 81f7728662dd11ec810800155d307d5b |
| queryContent | String | 否 | 【模糊查詢】 IPv6 帶寬實例名稱。 | test |
| bandwidthID | String | 否 | IPv6 帶寬 ID | bandwidth-sjwu65pf9t |
| pageNumber | Integer | 否 | 列表的頁碼，默認值為 1。 | 1 |
| 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 |
| returnObj | Array of Objects | 返回查詢的共享帶寬實例的詳細信息。 | 見下表 |
| totalCount | Integer | 總數 | 1 |
| currentCount | Integer | 分頁查詢時每頁的行數 | 1 |
| totalPage | Integer | 分頁查詢時總頁數 | 1 |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 |
|---|---|---|---|
| id | String | IPv6 帶寬 ID | bandwidth-sjwu65pf9t |
| status | String | IPv6 帶寬狀態: ACTIVE（正常） / EXPIRED（過期） / FREEZING（凍結） /CREATEING（創建中） | CREATEING |
| name | String | IPv6 帶寬名字 | xxxx |
| bandwidth | Integer | IPv6 帶寬峰值 mbps | 1 |
| resourceSpec | String | 獨享 / 共享 | standalone |
| paymentType | String | 計費類型 | 包年包月 |
| createdTime | String | IPv6 帶寬創建時間 | 2022-10-11T19:50:44Z |
| expiredTime | String | IPv6 帶寬過期時間 | 2022-11-11T19:50:44Z |
| ipAddress | String | IP 地址 | :: |
| ipv6GatewayID | String | IPv6 網關 ID | xxxx |
請求示例
GET /v4/ipv6_bandwidth/new-list?regionID=81f7728662dd11ec810800155d307d5b
請求體body
響應示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": [{
"id": "bandwidth-sjwu65pf9t",
"status": "CREATING",
"expired": false,
"name": "xxxx",
"ipAddress": "::",
"ipv6GatewayID": null,
"bandwidth": 1,
"payment_type": "包年包月",
"created_time": "2022-10-11T19:50:44Z",
"expired_time": "2022-10-11T19:50:44Z",
"resourceSpec": "standalone",
}],
"totalCount": 1,
"currentCount": 1,
"totalPage": 1
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 表示請求成功。 |
錯誤碼
請參考 錯誤碼說明。
