IPsec連接查詢健康檢查
更新時間 2025-04-03 11:12:21
最近更新時間: 2025-04-03 11:12:21
分享文章
IPsec連接查詢健康檢查。
接口功能介紹
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 | 請求參數無效 |
