接口功能介绍
IPsec vpn连接修改
接口约束
支持集群模式资源池。
URI
POST /v4/vpn/ipsec-vpn-connection/update
路径参数
无
Query参数
无
请求参数
请求header参数
无
请求body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | b342b77ef26b11ecb0ac0242ac110002 | |
| vpnConnectionName | 是 | String | VPN连接名称 | ipsec-test | |
| srcSubnet | 是 | String | 本端子网 | ["172.16.1.0/24"] | |
| dstCidr | 是 | String | 对端网络 | ["192.168.1.0/24"] | |
| psk | 是 | String | 预共享密钥 | ZmZuRkZ2ZV95UmU5OA== | |
| dpdSwitch | 否 | Boolean | dpd开关，默认值:true | true | |
| vpnConnectionID | 是 | String | VPN连接ID | 72a021e8-7488-11ee-b5fc-525400af7402 | |
| vpnServiceID | 是 | String | VPN实例ID | d333cfba-b0b7-501c-8ae3-89d6aa9c79e0 | |
| ipsecServiceID | 是 | String | VPN用户服务ID | fef53895-e8ae-471c-a6db-dca7f98dc36d | |
| policyMode | 否 | Boolean | 路由模式，默认值:true | true | |
| triggerMode | 否 | Boolean | 协商生效模式，默认值为：false | false | |
| ikeAuthAlgorithm | 是 | String | IKE策略:IKE认证算法，取值范围为：["sha1","sha256","sha384","sha512"] | sha1 | |
| ikeVersion | 是 | String | IKE策略:IKE版本，取值范围为：["v1","v2"] | v1 | |
| ikeEncryptionAlgorithm | 是 | String | IKE策略:IKE加密算法，取值范围为：["aes-128","aes-192","aes-256","3des"] | aes-128 | |
| ikeLifeTime | 是 | Integer | IKE策略:IKE生命周期 | 86400 | |
| ikePfs | 是 | String | IKE策略:DH算法，取值范围为：["group2","group5","group14"] | group2 | |
| phaseNegotiationMode | 是 | String | IPsec策略:协商模式，取值范围为：["main","aggressive"] | main | |
| ipsecAuthAlgorithm | 是 | String | IPsec策略:IPsec认证算法，取值范围为：["sha1","sha256","sha384","sha512"] | sha1 | |
| transformProtocol | 是 | String | IPsec策略:传输协议，其取值为"esp" | esp | |
| ipsecEncryptionAlgorithm | 是 | String | IPsec策略:IPsec策略算法，取值范围为：["aes-128","aes-192","aes-256","3des"] | aes-128 | |
| ipsecLifeTime | 是 | Integer | IPsec策略:IPsec生命周期 | 3600 | |
| ipsecPfs | 是 | String | IPsec策略:PFS，取值范围为：["group2","group5","group14"] | group2 | |
| authType | 否 | String | 认证方式 | pwd | |
| localID | 是 | String | 本地识别ID | 100.126.8.128 | |
| remoteID | 是 | String | 远端识别ID | 122.12.1.1 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码('800为成功，900为失败)，默认值:800 | 800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | 否 | Object | 返回参数 | returnObj |
表 returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| logMark | 否 | String | 链路追踪ID | 74cb2e66-1f95-45da-aac5-ee013470fd96 |
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "b342b77ef26b11ecb0ac0242ac110002",
"vpnConnectionName": "ipsec",
"vpnConnectionID": "32027bb8-755f-11ee-abc3-525400af7402",
"vpnServiceID": "d333cfba-b0b7-501c-8ae3-89d6aa9c79e0",
"ipsecServiceID": "fef53895-e8ae-471c-a6db-dca7f98dc36d",
"srcSubnet": [
"172.17.1.0/24",
"172.17.0.0/24"
],
"dstCidr": [
"192.168.17.0/24"
],
"psk": "ZmZuRkZ2ZV95UmU5OA==",
"dpdSwitch": true,
"triggerMode": false,
"policyMode": true,
"localID": "100.126.9.128",
"remoteID": "122.12.1.1",
"ikeAuthAlgorithm": "sha1",
"ikeVersion": "v1",
"ikeEncryptionAlgorithm": "aes-128",
"ikeLifeTime": 86400,
"ikePfs": "group5",
"ipsecAuthAlgorithm": "sha1",
"phaseNegotiationMode": "main",
"transformProtocol": "esp",
"ipsecEncryptionAlgorithm": "aes-128",
"ipsecLifeTime": 3600,
"ipsecPfs": "group5",
"authType": "pwd",
"customInfo": {
"identity": {
"userId": "0a6ccde87bf547eb924b855785f2189b",
"accountId": "77fa32cfcd82403a98ab4a517f859ad2"
}
}
}
响应示例
{
"returnObj": {
"logMark": "173596258491"
},
"errorCode": "",
"message": "success",
"description": "",
"statusCode": 800
}
状态码
| 状态码 | 含义 |
|---|---|
| 800 | 请求成功 |
| 900 | 请求未成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
| Openapi.Vpn.UpdateError | 内部错误，请重试。如果多次尝试失败，请提交工单 |
