接口功能介绍
下载VPN连接对端的配置信息
接口约束
支持主备模式资源池。
URI
GET /v4/vpn/config/query
路径参数
无
Query 参数
无
请求参数
请求头 header 参数
无
请求体 body 参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | ||
| vpnGatewayID | 是 | String | VPN网关 ID | ||
| userGatewayID | 是 | String | 用户网关 ID | ||
| vpnConnectionID | 是 | String | VPN连接 ID |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| 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连接策略信息列表 | result | |
| errorCode | String | 错误码 | ||
| message | String | 错误信息 | ||
| description | String | 描述 | ||
| statusCode | String | 800成功，900失败 |
表result
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| vpnGateway | Object | VPN网关配置信息 | VPNGateway | |
| userGateway | Object | 用户网关配置信息 | UserGateway | |
| vpnConnection | Object | VPN连接配置信息 | VPNConnection | |
| ikePolicy | Object | IKE 策略 | IkePolicy | |
| ipsecPolicy | Object | IPSec 策略 | IpsecPolicy |
表VPNGateway
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| vpnConnectionID | String | VPN连接ID | ||
| type | String | VPN类型(如IPSEC) | ||
| vpcID | String | VPC ID | ||
| vpnGatewayName | String | VPN网关名字 | ||
| vpnGatewayID | String | VPN网关ID | ||
| vpcName | String | VPC 名字 | ||
| ipAddress | String | IP地址 | ||
| bandwidth | Interger | 带宽 | ||
| isExpire | Boolean | 是否过期 | ||
| isTalkOrder | Boolean | 是否按需订单 | ||
| status | Integer | 状态码 | ||
| createDate | String | 创建时间 | ||
| deleteDate | String | 删除时间 |
表UserGateway
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| vpnConnectionID | String | VPN连接ID | ||
| userGatewayID | String | 用户网关ID | ||
| userGatewayName | String | 用户网关名字 | ||
| ipAddress | String | IP地址 | ||
| createDate | String | 创建时间 | ||
| description | String | 描述 |
表VPNConnection
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| dstCidr | Array of String | 目的子网列表 | ||
| srcSubnet | Array of String | 源子网列表 | ||
| vpnConnectionID | String | VPN连接ID | ||
| vpnConnectionName | String | VPN连接名字 | ||
| userGatewayID | String | 用户网关ID | ||
| userGatewayName | String | 用户网关名字 | ||
| vpnGatewayID | String | VPN网关ID | ||
| vpnGatewayName | String | VPN网关名字 | ||
| status | Integer | 状态码 | ||
| createDate | String | 创建时间 | ||
| description | String | 描述 |
表IkePolicy
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| authAlgorithm | String | IKE认证算法 | ||
| encryptionAlgorithm | String | IKE加密算法 | ||
| ikeVersion | String | IKE版本 | ||
| lifetime | String | 生命周期 | ||
| pfs | String | IKE DH算法 | ||
| phase1NegotiationMode | String | 协商模式 |
表IpsecPolicy
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| transformProtocol | String | 传输协议 | ||
| authAlgorithm | String | IPSEC认证算法 | ||
| encryptionAlgorithm | String | IPSEC 加密算法 | ||
| lifetime | String | IPSEC 生命周期 | ||
| pfs | String | IPSEC DH算法 |
请求示例
请求头
无
请求体 body
{
"regionID": "41f64827f25f468595ffa3a5deb5d15d",
"vpnGatewayID": "e023d46d-87ac-4f39-ae62-eb5c5434aa8c",
"userGatewayID": "b91735c9-41d8-40cf-88c6-f12a4064f09f",
"vpnConnectionID": "9480b3dc-f3e9-4a85-b170-0106f6218637"
}
响应示例
{
"returnObj": {
"currentCount": 1,
"totalCount": 1,
"totalPage": 1,
"results": [{
"vpnGateway": {
"status": "normal",
"vpnConnectionID": "9480b3dc-f3e9-4a85-b170-0106f6218637",
"vpnID": "e023d46d-87ac-4f39-ae62-eb5c5434aa8c",
"vpcID": "4df24b8e-b92d-473b-9f28-bf92dca073d1",
"vpnConnectionCount": 1,
"resourceID": "9d93348ff0da426294876b152a74a009",
"createDate": "2023-02-02T07:37:54Z",
"isTalkOrder": false,
"bandwidth": 5,
"vpcName": "vpc-7e53",
"isExpire": false,
"connectionLimit": 10,
"type": "IPsec",
"ipAddress": "100.127.7.231",
"vpnName": "vpn-gateway-ab55",
"deleteDate": "2023-05-02T07:38:38Z"
},
"ikePolicy": {
"lifetime": "86400",
"ikeVersion": "v1",
"pfs": "group5",
"authAlgorithm": "sha1",
"phase1NegotiationMode": "main",
"encryptionAlgorithm": "aes-128"
},
"userGateway": {
"vpnConnectionName": null,
"vpnConnectionID": "9480b3dc-f3e9-4a85-b170-0106f6218637",
"description": "",
"userGatewayID": "b91735c9-41d8-40cf-88c6-f12a4064f09f",
"createDate": "2023-02-02T09:10:07.581253Z",
"userGatewayName": "user-gateway-6941",
"ipAddress": "149.2.1.1"
},
"ipsecPolicy": {
"lifetime": "3600",
"encryptionAlgorithm": "aes-128",
"pfs": "group5",
"authAlgorithm": "sha1",
"transformProtocol": "esp"
},
"vpnConnection": {
"vpnConnectionName": "connection-caf9",
"vpnConnectionID": "9480b3dc-f3e9-4a85-b170-0106f6218637",
"description": "",
"userGatewayName": "user-gateway-6941",
"vpnGatewayName": "vpn-gateway-ab55",
"createDate": "2023-02-02T09:11:58.047522Z",
"dstCidr": ["172.29.55.0/24"],
"status": 1,
"vpnGatewayID": "e023d46d-87ac-4f39-ae62-eb5c5434aa8c",
"psk": "V2tkU2VtRkhlSFJqTVQxMTE=",
"srcSubnet": ["192.168.0.0/24"]
}
}]
},
"errorCode": "",
"message": "",
"description": "",
"statusCode": 800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
| 900 | 表示请求未成功 |
