獲取IPsec連接策略詳情
更新時間 2023-12-28 15:00:11
最近更新時間: 2023-12-28 15:00:11
分享文章
查詢已創建的VPN連接策略。
接口功能介紹
查詢已創建的VPN連接策略
接口約束
支持主備模式資源池。
URI
GET /v4/vpn/connection/policy
路徑參數
無
Query 參數
無
請求參數
請求頭 header 參數
無
請求體 body 參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID | ||
| vpnConnectionID | 是 | String | VPN連接 ID |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼(800為成功，900為失敗) | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | ||
| description | String | 失敗時的錯誤描述，一般為中文描述 | ||
| returnObj | Object | 返回對象 | returnObj | |
| errorCode | String | 業務細分碼，為product.module.code三段式碼 | ||
| errorDetail | Object | 錯誤明細 |
表returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| currentCount | Interger | 當前返回連接策略數量 | ||
| totalCount | Interger | 總共連接策略數量 | ||
| results | Array of Object | VPN連接策略信息列表 | Policy | |
| errorCode | String | 錯誤碼 | ||
| message | String | 錯誤信息 | ||
| description | String | 描述 | ||
| statusCode | String | 800成功，900失敗 |
表Policy
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| ikePolicy | Object | IKE 策略 | IkePolicy | |
| ipsecPolicy | Object | IPSec 策略 | IpsecPolicy |
表IkePolicy
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| authAlgorithm | String | IKE認證算法 | ||
| encryptionAlgorithm | String | IKE加密算法 | ||
| ikeVersion | String | IKE版本 | ||
| lifetime | String | 生命周期 | ||
| pfs | String | IKE DH算法 | ||
| phase1NegotiationMode | String | 本參數表示協商模式。 取值范圍： main mode aggressive mode |
表IpsecPolicy
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| transformProtocol | String | 傳輸協議 | ||
| authAlgorithm | String | IPSEC認證算法 | ||
| encryptionAlgorithm | String | IPSEC 加密算法 | ||
| lifetime | String | IPSEC 生命周期 | ||
| pfs | String | IPSEC DH算法 |
請求示例
請求頭
無
請求體 body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"vpnConnectionID": "f2fb2320-d02d-11ec-8d53-0242ac110002"
}
響應示例
{
"returnObj": {
"currentCount": 1,
"totalCount": 1,
"results": [{
"ikePolicy": {
"lifetime": "61",
"ikeVersion": "v2",
"pfs": "Group14",
"authAlgorithm": "sha512",
"phase1NegotiationMode": null,
"encryptionAlgorithm": "AES-128"
},
"ipsecPolicy": {
"lifetime": "604799",
"encryptionAlgorithm": "3DES",
"pfs": "DH Group5",
"authAlgorithm": "sha512",
"transformProtocol": null
}
}]
},
"errorCode": "",
"message": "",
"description": "",
"statusCode": 800
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 800 | 表示請求成功 |
| 900 | 表示請求未成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| OPENAPI.PatternCheck.NotValid | 請求參數無效 |
| OPENAPI.VPN.AccessFailed | 內部錯誤，請重試。如果多次嘗試失敗，請提交工單 |
