查詢帶寬列表v3
更新時間 2024-06-04 11:02:31
最近更新時間: 2024-06-04 11:02:31
分享文章
接口功能介紹
查詢帶寬列表
接口約束
無
URI
GET /v3/bandwidth/describe
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 資源池ID。 | d8bbd132b53a11e9b0e40242ac110002 | |
| name | 否 | String | 帶寬名稱 | API_Test | |
| pageNum | 否 | Integer | 頁碼，至少1，默認1 | 1 | |
| pageSize | 否 | Integer | 每頁數量，最大100，默認10 | 10 |
請求參數
請求頭header參數
無
請求體body參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 狀態碼。可能值： - 800：請求成功。 - 900：請求失敗。 |
800 | |
| error | String | 錯誤碼。 | ECPC_1000 | |
| message | String | 提示信息。 | OK | |
| returnObj | Object | 返回數據對象 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| total | Long | 總記錄數 | ||
| list | Array of Objects | 數據列表 | list |
表 list
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| bandwidthOid | String | 帶寬ID | bw-s9561sofpjk7kh52i0038 | |
| name | String | 帶寬名稱 | bandwidth-aukc8xb | |
| status | String | 狀態狀態（Creating-創建中;Normal-正常;Deleted-已刪除;Changing-變更中;Unhealthy-異常;Frozen-凍結;Deleting-刪除中） | Creating | |
| size | Integer | 帶寬大小（單位：Mbps） | 1 | |
| vpcOid | String | VPC ID | vpc-xxdwpyq2jgc62h8fjd2e4 | |
| vpcName | String | VPC名稱 | vpc-u9ck | |
| elasticIpAddress | String | 彈性IP地址 | ||
| createTime | String | 創建時間。以ISO 8601為標準，并使用UTC+0時間，格式為yyyy-MM-ddTHH:mm:ssZ。 | 2023-10-20T07:23:52Z | |
| expireTime | String | 到期時間。以ISO 8601為標準，并使用UTC+0時間，格式為yyyy-MM-ddTHH:mm:ssZ。 | 2023-11-19T09:31:38Z |
枚舉參數
無
請求示例
請求url
無
請求頭header
無
請求體body
無
響應示例
{"statusCode":800,"message":"OK.","returnObj":{"total":1,"list":[{"bandwidthOid":"bw-foo","name":"bandwidth-xxx","status":"Creating","size":1,"vpcOid":"vpc-xxx","vpcName":"vpc-xxx","createTime":"2022-08-24T09:01:58Z","expireTime":"2026-01-11T02:27:53Z"}]}}
狀態碼
請參考
錯誤碼
請參考
