資源列表查詢:共享帶寬
更新時間 2023-07-19 11:41:00
最近(jin)更新(xin)時間: 2023-07-19 11:41:00
分享(xiang)文章(zhang)
接口功能介紹
調用(yong)此接口可(ke)根據篩選條件查(cha)詢(xun)資源池下共享帶寬的列表。
接口約束
regionID(資源(yuan)池)存在。
URI
GET /v4/monitor/query-traffic-list
請求參數
Query參數
| 參數 | 參數類型 | 是否必填 | 示例 | 說明 | 下級對象 |
|---|---|---|---|---|---|
| regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | 資源池ID | |
| pageNo | Integer | 否 | 1 | 頁碼,默認為1 | |
| page | Integer | 否 | 1 | 頁碼,默認為1,建議使用pageNo,該參數后續會下線 | |
| pageSize | Integer | 否 | 1 | 頁大小,默認為10 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼(800為成功,900為失敗),默認值:800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼,參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述,一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述,一般為中文描述 | 成功 | |
| returnObj | Object | 返回對象 | returnObj |
表returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| trafficList | Array of Objects | 共享帶寬資源列表 | traffic | |
| totalCount | Integer | 獲取對象數據條數 | 138 | |
| totalPage | Integer | 總頁數 | 1 | |
| currentCount | Integer | 當前頁記錄數 | 2 | |
| page | Integer | 頁碼,建議參考請求參數pageNo,該參數后續會下線 | 1 | |
| pageSize | Integer | 頁大小,建議參考請求參數pageSize,該參數后續會下線 | 10 |
表traffic
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| instanceID | String | 共享帶寬實例ID | bandwidth-xadwzslpkw | |
| instanceName | String | 共享帶寬實例名稱 | bandwidth-78a4 | |
| deviceUUID | String | 唯一標識ID | bandwidth-xadwzslpkw |
請求示例
GET /v4/monitor/query-traffic-list?regionID=81f7728662dd11ec810800155d307d5b&page=1&pageSize=5
響應示例
{
"statusCode":800,
"returnObj":{
"trafficList":[
{
"instanceID":"bandwidth-xadwzslpkw",
"instanceName":"bandwidth-78a4",
"deviceUUID":"bandwidth-xadwzslpkw"
},
{
"instanceID":"bandwidth-6spt8osqmg",
"instanceName":"bandwidth-f5d8",
"deviceUUID":"bandwidth-6spt8osqmg"
}
],
"totalCount":2,
"totalPage":1,
"currentCount":2,
"page":1,
"pageSize":5
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| 其他 | 參見公共錯誤碼說明 |