接口功能介绍
IPsec连接健康检查查询
接口约束
支持集群模式资源池。
URI
GET /v4/vpn/ipsec-health-check/list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | b342b77ef26b11ecb0ac0242ac110002 | |
| vpnConnectionID | 是 | String | vpn connection id | 725b7f5a-d25d-11ef-a030-525400bf5caf |
请求参数
请求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 | 列表 | results |
表results
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 否 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| vpnConnectionID | 否 | String | vpn connection id | 725b7f5a-d25d-11ef-a030-525400bf5caf | |
| sourceIP | 否 | String | 源IP | 11.2.3.5 | |
| targetIP | 否 | String | 目的IP | 12.3.4.9 | |
| enableHealth | 否 | Boolean | 是否启用健康检查 | true | |
| detectTime | 否 | Integer | 探测时间，单位S，取值范围:[1~120] | 20 | |
| detectNumber | 否 | Integer | 探测次数，取值范围:[1~50] | 30 | |
| dropThreshold | 否 | Integer | 异常阈值，单位百分比，取值范围:[1~100] | 12 | |
| routeNotify | 否 | Boolean | 是否关联路由 | true |
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"totalCount": 1,
"currentCount": 1,
"totalPage": 1,
"logMark": "74cb2e66-1f95-45da-aac5-ee013470fd96",
"results": [
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"vpnConnectionID": "725b7f5a-d25d-11ef-a030-525400bf5caf",
"sourceIP": "11.2.3.5",
"targetIP": "12.3.4.9",
"enableHealth": true,
"detectTime": 20,
"detectNumber": 30,
"dropThreshold": 12,
"routeNotify": true
}
]
}
}状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| HealthCheck.PatternCheck.NotValid | 请求参数无效 |
