接口功能介绍
获取VPN网关配额详情
接口约束
支持集群模式资源池。
URI
GET /v4/vpn/vpn-gateway-quato/list
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID | b342b77ef26b11ecb0ac0242ac110002 |
请求参数
请求header参数
无
请求body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 否 | integer | 返回状态码('800为成功,900为失败),默认值:800 | 800 | |
errorCode | 否 | string | 业务细分码,为product.module.code三段式码 | ||
message | 否 | string | 失败时的错误描述,一般为英文描述 | ||
description | 否 | string | 失败时的错误描述,一般为中文描述 | ||
returnObj | 否 | object | 返回参数 | returnObj |
表returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
totalCount | 否 | integer | 查询的总记录数 | 3 | |
currentCount | 否 | integer | 当前页记录数 | 3 | |
results | 否 | array | 列表 | results |
表results
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
resourceType | 否 | string | 资源类型 | ssl_vpn | |
quato | 否 | string | 已用配额 | 10 | |
used | 否 | string | 可用配额 | 1 |
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{"returnObj":
{"currentCount": 2,
"totalCount": 2,
"results": [{
"resourceType": "ssl_vpn",
"used": 0,
"quota": 10},
{"resourceType": "ipsec_vpn",
"used": 0,
"quota": 10}]},
"errorCode": "",
"message": "success",
"description": "",
"statusCode": 800}
状态码
状态码 | 含义 |
---|---|
200 | 请求成功 |
错误码
errorCode | 含义 |
---|---|
Gateway.PatternCheck.NotValid | 请求参数无效 |