VPN相關資源用量獲取
更新時間 2023-12-28 15:00:13
最近更新時間: 2023-12-28 15:00:13
分享文章
VPN相關資源用量獲取。
接口功能介紹
VPN相關資源用量獲取
接口約束
支持集群模式資源池。
URI
GET /v4/vpn/usage/list
路徑參數
無
Query參數
無
請求參數
請求header參數
無
請求body參數
get請求包含body參數,報文頭指定application/json,且body結構對象需要轉json。
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID | b342b77ef26b11ecb0ac0242ac110002 | |
| usageType | 否 | String | 請求類型 取值范圍: vpn_service:vpn網關實例數 user_service:ipsec vpn用戶服務數 vpn_connection:ipsec vpn連接數 |
vpn_connection |
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回狀態碼 取值范圍: 800：成功 900：失敗 |
800 | |
| errorCode | 否 | String | 業務細分碼，為product.module.code三段式碼 | ||
| message | 否 | String | 失敗時的錯誤描述，一般為英文描述 | ||
| description | 否 | String | 失敗時的錯誤描述，一般為中文描述 | ||
| returnObj | 否 | Object | 返回對象 | returnObj |
表returnObj
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| logMark | 否 | String | 鏈路追蹤ID | 74cb2e66-1f95-45da-aac5-ee013470fd96 | |
| totalCount | 否 | Integer | 查詢的總記錄數 | 3 | |
| currentCount | 否 | Integer | 當前頁記錄數 | 2 | |
| results | 否 | Array of Objects | 列表 | results |
表results
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| vpnServiceCount | 否 | Integer | vpn網關實例數 | 3 | |
| userServiceCount | 否 | Integer | IPSEC VPN用戶服務數 | 3 | |
| vpnConnectionCount | 否 | Integer | IPSEC VPN連接數 | 4 |
請求示例
請求url
無
請求頭header
無
請求體body
{
"regionID": "b342b77ef26b11ecb0ac0242ac110002"
}
響應示例
{
"returnObj":{
"totalCount":3,
"currentCount":1,
"results":[
{
"vpnServiceCount":5,
"vpnConnectionCount":2,
"userServiceCount":2
}
],
"logMark":"117517036453"
},
"errorCode":"",
"message":"success",
"description":"",
"statusCode":800
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 800 | 表示請求成功 |
| 900 | 表示請求未成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Openapi.PatternCheck.NotValid | 請求參數無效 |
