IPsec連接查詢
更新時間 2025-04-03 11:12:07
最近更新時間: 2025-04-03 11:12:07
分享文章
查詢已創建的VPN連接。
接口功能介紹
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 | |
| vpnServiceID | 否 | String | vpn網關實例ID | 556781e8-7488-11ee-b5fc-525400af7402 | |
| queryContent | 否 | String | 模糊查詢 | ipsec | |
| pageNo | 否 | Integer | 頁碼 | 2 | |
| pageSize | 否 | Integer | 頁面大小 | 3 | |
| projectID | 否 | String | 企業項目ID | "0" |
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| 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 | ||
| projectID | 否 | String | 企業項目ID | "0" |
請求示例
請求url
無
請求頭header
無
請求體body
{
"regionID": "b342b77ef26b11ecb0ac0242ac110002",
"vpnConnectionName": "ipsec-test",
"vpnConnectionID":"72a021e8-7488-11ee-b5fc-525400af7402",
"pageNo": 1,
"pageSize": 1,
"projectID": "0"
}
響應示例
{
"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"
],
"projectID": "0",
"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不正確 |