接口功能介绍
查询VPN连接相关的资源使用情况
接口约束
支持主备模式资源池。
URI
GET /v4/vpn/usage/query
路径参数
无
Query 参数
无
请求参数
请求头 header 参数
无
请求体 body 参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | ||
| resourceType | 是 | String | 本参数表示VPN资源类型。 取值范围： all：所有类型 vpn_gateway：VPN网关类型 user_gateway：用户网关类型 vpn_connection：VPN连接类型 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败) | ||
| message | String | 失败时的错误描述，一般为英文描述 | ||
| description | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | Object | 返回对象 | returnObj | |
| errorCode | String | 业务细分码，为product.module.code三段式码 | ||
| errorDetail | Object | 错误明细 |
表returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| currentCount | Interger | 当前返回数据的数量 | ||
| totalCount | Interger | 总共数据的数量 | ||
| totalPage | Interger | 总共数据的页数 | ||
| results | Array of Object | VPN连接资源用量信息列表 | Usage | |
| errorCode | String | 错误码 | ||
| message | String | 错误信息 | ||
| description | String | 描述 | ||
| statusCode | String | 800成功，900失败 |
表Usage
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| vpnGatewayCount | Integer | VPN网关数量 | ||
| userGatewayCount | Integer | 用户网关数量 | ||
| vpnConnectionCount | Integer | VPN连接数量 |
请求示例
请求头
无
请求体 body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"resourceType": "all"
}
响应示例
{
"returnObj": {
"currentCount": 1,
"totalCount": 1,
"totalPage": 1,
"results": [{
"vpnGatewayCount": 1,
"userGatewayCount": 1,
"vpnConnectionCount": 1
}]
},
"errorCode": "",
"message": "",
"description": "",
"statusCode": 800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
| 900 | 表示请求未成功 |
