接口功能介绍
IPsec vpn连接查询
接口约束
支持集群模式资源池。
URI
GET /v4/vpn/ipsec-vpn-connection/list
路径参数
无
Query参数
无
请求参数
请求header参数
无
请求body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | b342b77ef26b11ecb0ac0242ac110002 | |
| vpnConnectionName | 否 | String | IPsec VPN连接名称 | ipsec-test | |
| vpnConnectionID | 否 | String | IPsec VPN连接ID | 72a021e8-7488-11ee-b5fc-525400af7402 | |
| queryContent | 否 | String | 模糊查询 | ipsec | |
| pageNo | 否 | Integer | 页码 | 2 | |
| pageSize | 否 | Integer | 页面大小 | 3 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| 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 | |
| totalPage | 否 | Integer | 总页数 | 1 | |
| logMark | 否 | String | 链路追踪ID | 74cb2e66-1f95-45da-aac5-ee013470fd96 | |
| results | 否 | Array of Objects | 列表 | results |
表 results
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| vpnConnectionName | 否 | String | VPN连接名称 | ||
| vpnConnectionID | 否 | String | VPN连接ID | ||
| vpnServiceName | 否 | String | VPN实例名称 | ||
| vpnServiceID | 否 | String | VPN实例ID | ||
| ipsecServiceID | 否 | String | VPN用户服务ID | ||
| srcSubnetList | 否 | Array of Strings | 本端子网，值类型为String | ||
| dstCidrList | 否 | Array of Strings | 对端网络，值类型为String | ||
| psk | 否 | String | 预共享密钥 | ||
| createTime | 否 | String | create time |
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "b342b77ef26b11ecb0ac0242ac110002",
"vpnConnectionName": "ipsec-test",
"vpnConnectionID":"72a021e8-7488-11ee-b5fc-525400af7402",
"pageNo": 1,
"pageSize": 1
}
响应示例
{
"returnObj": {
"currentCount": 1,
"totalCount": 1,
"totalPage": 1,
"results": [
{
"vpnConnectionName": "ipsec-test",
"vpnConnectionID": "72a021e8-7488-11ee-b5fc-525400af7402",
"vpnServiceID": "d333cfba-b0b7-501c-8ae3-89d6aa9c79e0",
"srcSubnetList": [
"172.16.1.0/24"
],
"psk": "ZmZuRkZ2ZV95UmU5OA==",
"dstCidrList": [
"192.168.1.0/24"
],
"vpnServiceName": "ipsec-test-mao",
"ipsecServiceID": "fef53895-e8ae-471c-a6db-dca7f98dc36d",
"createTime": "2023-10-27 05:19:48"
}
],
"logMark": "399168507736"
},
"errorCode": "",
"message": "success",
"description": "",
"statusCode": 800
}
状态码
| 状态码 | 含义 |
|---|---|
| 800 | 请求成功 |
| 900 | 请求未成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| Openapi.Parameter.regionID | 请求参数错误 |
| vpn.RegionInfo.Empty | 资源池信息为空，可能资源池ID不正确 |
