查詢共享帶寬列表
更新時間 2023-07-19 13:58:47
最近更新時間: 2023-07-19 13:58:47
分享文章
接口功能介紹
調用此接口可查詢指定區域下共享帶寬實例列表。
接口約束
無。
URI
GET /v4/bandwidth/list
請求參數
Query 參數
| 參數 | 參數類型 | 是否必填 | 說明 | 示例 |
|---|---|---|---|---|
| regionID | String | 是 | 共享帶寬所在的區域id。 | 81f7728662dd11ec810800155d307d5b |
| queryContent | String | 否 | 【模糊查詢】 共享帶寬實例名稱。 | |
| projectID | String | 否 | 企業項目 ID，默認為"0" | 0 |
| 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 |
| totalCount | Integer | 列表條目數。 | 20 |
| currentCount | Integer | 分頁查詢時每頁的行數。 | 4 |
| totalPage | Integer | 分頁查詢時總頁數。 | 5 |
| returnObj | Array of Objects | object | 返回查詢的共享帶寬實例的詳細信息。 |
表 returnObj
| 參數 | 參數類型 | 示例 | 說明 |
|---|---|---|---|
| id | String | 共享帶寬id。 | bandwidth-sjwu65pf9t |
| status | String | 共享帶寬狀態: ACTIVE / EXPIRED / FREEZING | ACTIVE |
| bandwidth | int | 共享帶寬的帶寬峰值， 單位：Mbps。 | 5 |
| name | String | 共享帶寬名稱。 | share_ip_069f |
| eips | Array of Objects | 綁定的彈性 IP 列表 ｜ 見下表 |
表 eips
| 參數 | 參數類型 | 說明 | 示例 |
|---|---|---|---|
| ip | String | 彈性 IP 的 IP | 100.124.10.1 |
| eipID | String | 彈性 IP 的 ID | eip-ieeq36299f |
請求示例
GET /v4/bandwidth/new-list?regionID=xxx
請求體body
響應示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": [
{
"id": "bandwidth-sjwu65pf9t",
"status": "ACTIVE",
"bandwidth": 5,
"name": "share_ip_069f",
"eips": []
},
{
"id": "bandwidth-jfx75s4dga",
"status": "ACTIVE",
"bandwidth": 5,
"name": "share_ip_b290",
"eips": []
},
{
"id": "bandwidth-taayvohh94",
"status": "ACTIVE",
"bandwidth": 5,
"name": "share_ip_dd21",
"eips": []
},
{
"id": "bandwidth-fd4yt9ci58",
"status": "ACTIVE",
"bandwidth": 5,
"name": "share_ip_2200",
"eips": []
},
{
"id": "bandwidth-ulvku3pots",
"status": "ACTIVE",
"bandwidth": 5,
"name": "share_ip_f07e",
"eips": []
}
],
"currentCount": 5,
"totalCount": 5,
"totalPage": 1
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 表示請求成功。 |
錯誤碼
請參考 錯誤碼說明。
