接口功能介绍
获取VPN网关资源池详情
接口约束
支持集群模式资源池。
URL
GET /v4/vpn/vpn-region/list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
| regionID | 是 | String | 资源池ID | b342b77ef26b11ecb0ac0242ac110002 |
请求参数
请求header参数
无
请求body参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
| statusCode | 否 | integer | 返回状态码 取值范围: 800：成功 900：失败 | 800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | 否 | Object | 返回对象 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
| totalCount | 否 | integer | 查询的总记录数 | 3 | |
| currentCount | 否 | integer | 当前页记录数 | 3 | |
| results | 否 | array | 列表 | results |
表results
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
| regionID | 否 | string | 资源池ID | a2f82c2828ee11ed9df90242ac110002 | |
| regionName | 否 | string | 资源池名称 | 贵州CNP |
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{"returnObj":
{"currentCount": 4,
"totalCount": 4,
"results":
[{"regionID": "a2f82c2828ee11ed9df90242ac110002",
"regionName": "贵州CNP"},
{"regionID": "b342b77ef26b11ecb0ac0242ac110002-test",
"regionName": "贵州实验局-AZ2"},
{"regionID": "81f7728662dd11ec810800155d307d5b",
"regionName": "内蒙8"},
{"regionID": "b342b77ef26b11ecb0ac0242ac110002",
"regionName": "贵州实验局"}]},
"errorCode": "",
"message": "success",
"description": "",
"statusCode": 800}
}状态码
| 状态码 | 含义 |
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
| Gateway.PatternCheck.NotValid | 请求参数无效 |
