接口功能介绍
IPsec vpn目的路由查询
接口约束
支持集群模式资源池。
URI
GET /v4/vpn/ipsec-static-route/list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | b342b77ef26b11ecb0ac0242ac110002 | |
| vpnGatewayID | 是 | String | vpn网关ID | 556781e8-7488-11ee-b5fc-525400af7402 | |
| queryContent | 否 | String | 模糊查询 | ipsec |
请求参数
请求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 | |
| totalPage | 否 | Integer | 总页数 | 1 | |
| logMark | 否 | String | 链路追踪ID | 74cb2e66-1f95-45da-aac5-ee013470fd96 | |
| results | 否 | Array Of Objects | 列表 | results |
表results
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| routeID | 否 | String | 目的路由ID | 5da93879-b50b-4aed-bbfb-9fd989f52058 | |
| targetIP | 否 | String | 目的IP | 2.123.22.0/24 | |
| nextHopType | 否 | Integer | 下一跳类型 | 1 | |
| nextHop | 否 | String | 下一跳具体资源 | 725b7f5a-d25d-11ef-a030-525400bf5caf | |
| nextHopName | 否 | String | 下一跳具体资源名称 | connection-215f | |
| preference | 否 | String | 路由权重，取值范围： master:主链路 slave:从链路 | master | |
| vpnGatewayID | 否 | String | vpn gw id | 2ac9a9f4-86c8-4521-998b-2e0a7c624eed | |
| isPublish | 否 | Boolean | 是否发布 | true | |
| vpcID | 否 | String | vpc ID | vpc-gscta6zp8m | |
| projectID | 否 | String | project id | 0 | |
| ipsecConnectStatus | 否 | String | IPSec连接状态 | inaccessible | |
| routeWeight | 否 | String | 路由权重，取值范围:[1~255] | 100 | |
| healthStatus | 否 | String | 健康检查状态 | disable | |
| createTime | 否 | String | create time | 2025-02-19 07:24:03 |
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"totalCount": 3,
"currentCount": 3,
"totalPage": 1,
"logMark": "74cb2e66-1f95-45da-aac5-ee013470fd96",
"results": [
{
"routeID": "5da93879-b50b-4aed-bbfb-9fd989f52058",
"targetIP": "2.123.22.0/24",
"nextHopType": "1",
"nextHop": "725b7f5a-d25d-11ef-a030-525400bf5caf",
"nextHopName": "connection-215f",
"preference": "master",
"vpnGatewayID": "2ac9a9f4-86c8-4521-998b-2e0a7c624eed",
"isPublish": true,
"vpcID": "vpc-gscta6zp8m",
"projectID": "0",
"ipsecConnectStatus": "inaccessible",
"routeWeight": "100",
"healthStatus": "disable",
"createTime": "2025-02-19 07:24:03"
}
]
}
}
{"returnObj": {"currentCount": 2, "totalCount": 2, "totalPage": null, "results": [{"ipsecConnectStatus": "inaccessible", "routeWeight": "100", "vpcID": "vpc-gscta6zp8m", "projectID": "0", "nextHop": "725b7f5a-d25d-11ef-a030-525400bf5caf", "preference": "master", "nextHopType": "1", "priority": null, "targetIP": "2.123.22.0/24", "healthStatus": "disable", "vpnGatewayID": "2ac9a9f4-86c8-4521-998b-2e0a7c624eed", "isPublish": true, "createTime": "2025-02-19 07:24:03", "nextHopName": "connection-215f", "policyRouteID": "5da93879-b50b-4aed-bbfb-9fd989f52058"}, {"ipsecConnectStatus": "inaccessible", "routeWeight": "100", "vpcID": "vpc-gscta6zp8m", "projectID": "0", "nextHop": "725b7f5a-d25d-11ef-a030-525400bf5caf", "preference": "master", "nextHopType": "1", "priority": null, "targetIP": "12.3.4.0/24", "healthStatus": "disable", "vpnGatewayID": "2ac9a9f4-86c8-4521-998b-2e0a7c624eed", "isPublish": false, "createTime": "2025-02-19 07:24:03", "nextHopName": "connection-215f", "policyRouteID": "917ac0b2-ee91-11ef-a350-525400bf5caf"}], "logMark": "764278726238"}, "errorCode": "", "message": "success", "description": "", "statusCode": 800}状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| StaticRoute.PatternCheck.NotValid | 请求参数无效 |
