接口功能介绍
获取VPN网关详情
接口约束
支持集群模式资源池。
URI
GET /v4/vpn/vpn-gateway/list
路径参数
无
Query参数
无
请求参数
请求header参数
无
请求body参数
get请求包含body参数,报文头指定application/json,且body结构对象需要转json。
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | b342b77ef26b11ecb0ac0242ac110002 | |
| vpnGatewayID | 是 | String | vpn网关ID | 740c0e7c-cd6b-4501-ba41-f86a83f8f837 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码 取值范围: 800：成功 900：失败 |
800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | 否 | Object | 返回对象 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| totalCount | 否 | Integer | 查询的总记录数 | 3 | |
| currentCount | 否 | Integer | 当前页记录数 | 2 | |
| logMark | 否 | String | 链路追踪ID | 74cb2e66-1f95-45da-aac5-ee013470fd96 | |
| results | 否 | Array of Objects | 列表 | results |
表results
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| vpnGatewayID | 否 | String | vpn网关ID | 740c0e7c-cd6b-4501-ba41-f86a83f8f837 | |
| vpnGatewayName | 否 | String | vpn网关名称 | 123 | |
| ipsecStatus | 否 | String | ipsec状态 取值范围: normal：正常 null：不正常 |
normal | |
| sslStatus | 否 | String | ssl状态 取值范围: normal：正常 null：不正常 |
normal | |
| vpnServiceType | 否 | String | 网关实例类型 取值范围: cloud_high:云间高速类型 vpc:vpc类型 |
vpc | |
| vpnGatewayType | 否 | String | 网关类型 取值范围： normal：为普通类型 secret：为国密类型 |
normal | |
| ipsecConnectLimit | 否 | Integer | ipsec连接数限制 | 0 | |
| sslConnectLimit | 否 | String | ssl连接数限制 | 10 | |
| bandwidth | 否 | Integer | 带宽大小，单位为Mbps | 10 | |
| ipsecCreateTime | 否 | String | ipsec create time | 2022-07-16 07:27:26 | |
| sslCreateTime | 否 | String | ssl create time | 2022-07-16 07:27:26 | |
| projectID | 否 | String | project ID | 0 | |
| vpnType | 否 | Array of Strings | vpn类型 取值范围: ipsec：ipsec类型 ssl：ssl类型 ipsec，ssl：ipsec+ssl类型 |
ipsec | |
| vpcName | 否 | String | vpc名称 | vpc-9ce5 | |
| vpcID | 否 | String | vpc ID | vpc-6jwowr794e | |
| localSubnets | 否 | Array of Objects | 子网信息 | "localSubnets":[ { "subnetID":"subnet-a0l1wqi058", "subnetName":"subnet-9ce5", "cidr":"10.112.0.0/24" } |
localSubnets |
| ecID | 否 | String | 接入云间高速ID | 740c0e7c-cd6b-4501-ba41-f86a83f8f837 | |
| ipsecConnectedNum | 否 | Integer | ipsec已连接数 | 2 | |
| sslUserNum | 否 | Integer | ssl客户端数量 | 2 | |
| ipsecExpiredTime | 否 | String | ipsec到期时间 | 2023-07-16 07:27:26 | |
| sslExpiredTime | 否 | String | ssl到期时间 | 2023-07-16 07:27:26 | |
| vnpGatewayIP | 否 | String | vpn网关IP | 100.126.8.211 | |
| ipsecDescription | 否 | String | ipsec描述信息 | ipsec11 | |
| sslDescription | 否 | String | ssl 描述信息 | ssl11 |
表localSubnets
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| subnetID | 否 | String | subnet ID | subnet-a0l1wqi058 | |
| subnetName | 否 | String | subnet name | subnet-9ce5 | |
| cidr | 否 | String | cidr | 10.112.0.0/24 |
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "b342b77ef26b11ecb0ac0242ac110002",
"vpnGatewayID": "cd3c78f3-8b49-4ad0-ae3e-15342a744e73"
}
响应示例
{
"returnObj":{
"currentCount":1,
"totalCount":1,
"results":[
{
"ipsecDescription":"",
"ipsecStatus":null,
"projectID":"0",
"vpnType":[
"ssl"
],
"ipsecConnectedNum":0,
"vpnGatewayName":"123",
"bandwidth":10,
"vpcName":"vpc-9ce5",
"ipsecConnectLimit":0,
"ipsecCreateTime":null,
"sslExpiredTime":"2023-07-16 07:27:26",
"vnpGatewayIP":"100.126.8.182/32",
"vpnServiceType":"vpc",
"sslConnectLimit":"10",
"vpcID":"vpc-6jwowr794e",
"ecID":"",
"vpnGatewayType":"normal",
"sslStatus":"normal",
"vpnGatewayID":"740c0e7c-cd6b-4501-ba41-f86a83f8f837",
"sslDescription":"23",
"sslUserNum":0,
"ipsecExpiredTime":null,
"sslCreateTime":"2023-06-16 07:27:15",
"localSubnets":[
{
"subnetID":"subnet-a0l1wqi058",
"subnetName":"subnet-9ce5",
"cidr":"10.112.0.0/24"
}
]
}
],
"logMark":"118435974014"
},
"errorCode":"",
"message":"success",
"description":"",
"statusCode":800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
| 900 | 表示请求未成功 |
错误码
| errorCode | 描述 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
