接口功能介绍
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 | 请求参数无效 |
