pfs
@@ -646,8 +645,8 @@
"lifetime_seconds": 3600,
"encapsulation_mode": "tunnel"
},
- "created_at": "2024-06-28T09:41:11.445Z",
- "updated_at": "2024-06-28T09:41:11.445Z",
+ "created_at": "2025-06-11T13:59:59.633Z",
+ "updated_at": "2025-06-11T13:59:59.633Z",
"enterprise_project_id": "0"
},
{
@@ -661,7 +660,6 @@
"tunnel_local_address": "169.254.77.169/30",
"tunnel_peer_address": "169.254.77.170/30",
"policy_rules": [{
- "rule_index": 1,
"source": "10.0.0.0/24",
"destination": [
"192.168.44.0/24"
@@ -675,9 +673,9 @@
"authentication_method": "pre-share",
"lifetime_seconds": 3600,
"local_id_type": "ip",
- "local_id": "88.88.201.167",
+ "local_id": "88.***.***.167",
"peer_id_type": "ip",
- "peer_id": "10.111.222.21",
+ "peer_id": "10.***.***.21",
"dpd": {
"interval": 30,
"timeout": 15,
@@ -692,14 +690,14 @@
"lifetime_seconds": 3600,
"encapsulation_mode": "tunnel"
},
- "created_at": "2024-06-28T07:24:27.674Z",
- "updated_at": "2024-06-28T07:24:27.674Z",
+ "created_at": "2022-06-09T07:24:27.674Z",
+ "updated_at": "2022-06-09T07:24:27.674Z",
"enterprise_project_id": "0",
"ha_role":"master"
}
],
"page_info": {
- "next_marker": "2024-06-28T07:24:27.674Z",
+ "next_marker": "2025-06-09T07:24:27.674Z",
"current_count": 2
},
"request_id": "1d94a4e8-fdc2-7bfd-943e-19bfa9b234ac",
@@ -746,8 +744,8 @@
"lifetime_seconds": 3600,
"encapsulation_mode": "tunnel"
},
- "created_at": "2024-06-28T14:24:25.115Z",
- "updated_at": "2024-06-28T14:24:25.115Z",
+ "created_at": "2025-06-11T14:24:25.115Z",
+ "updated_at": "2025-06-11T14:24:25.115Z",
"enterprise_project_id": "0"
},
{
@@ -762,7 +760,6 @@
"tunnel_peer_address": "169.254.77.170/30",
"policy_rules": [
{
- "rule_index": 1,
"source": "10.0.0.0/24",
"destination": [
"192.168.44.0/24"
@@ -777,9 +774,9 @@
"authentication_method": "pre-share",
"lifetime_seconds": 3600,
"local_id_type": "ip",
- "local_id": "88.88.201.167",
+ "local_id": "88.***.***.167",
"peer_id_type": "ip",
- "peer_id": "10.111.222.21",
+ "peer_id": "10.***.***.21",
"dpd": {
"interval": 30,
"timeout": 15,
@@ -794,14 +791,14 @@
"lifetime_seconds": 3600,
"encapsulation_mode": "tunnel"
},
- "created_at": "2024-06-28T13:59:59.633Z",
- "updated_at": "2024-06-28T13:59:59.633Z",
+ "created_at": "2025-06-11T13:59:59.633Z",
+ "updated_at": "2025-06-11T13:59:59.633Z",
"enterprise_project_id": "0",
"ha_role":"master"
}
],
"page_info": {
- "next_marker": "2024-06-28T13:59:59.633Z",
+ "next_marker": "2025-06-11T13:59:59.633Z",
"current_count": 2
},
"request_id": "1d94a4e8-fdc2-7bfd-943e-19bfa9b234ac",
@@ -848,8 +845,8 @@
"lifetime_seconds": 3600,
"encapsulation_mode": "tunnel"
},
- "created_at": "2024-06-28T14:24:25.115Z",
- "updated_at": "2024-06-28T14:24:25.115Z",
+ "created_at": "2025-06-11T14:24:25.115Z",
+ "updated_at": "2025-06-11T14:24:25.115Z",
"enterprise_project_id": "0",
"ha_role":"master"
},
@@ -865,7 +862,6 @@
"tunnel_peer_address": "169.254.77.170/30",
"policy_rules": [
{
- "rule_index": 1,
"source": "10.0.0.0/24",
"destination": [
"192.168.44.0/24"
@@ -880,9 +876,9 @@
"authentication_method": "pre-share",
"lifetime_seconds": 3600,
"local_id_type": "ip",
- "local_id": "88.88.201.167",
+ "local_id": "88.***.***.167",
"peer_id_type": "ip",
- "peer_id": "10.111.222.21",
+ "peer_id": "10.***.***.21",
"dpd": {
"interval": 30,
"timeout": 15,
@@ -897,14 +893,14 @@
"lifetime_seconds": 3600,
"encapsulation_mode": "tunnel"
},
- "created_at": "2024-06-28T13:59:59.633Z",
- "updated_at": "2024-06-28T13:59:59.633Z",
+ "created_at": "2025-06-11T13:59:59.633Z",
+ "updated_at": "2025-06-11T13:59:59.633Z",
"enterprise_project_id": "0",
"ha_role":"master"
}
],
"page_info": {
- "next_marker": "2024-06-28T13:59:59.633Z",
+ "next_marker": "2025-06-11T13:59:59.633Z",
"current_count": 2
},
"request_id": "1d94a4e8-fdc2-7bfd-943e-19bfa9b234ac",
diff --git a/docs/vpn/api-ref/vpn_api_0030.html b/docs/vpn/api-ref/vpn_api_0030.html
index c8a0af673..2ac17cfdb 100644
--- a/docs/vpn/api-ref/vpn_api_0030.html
+++ b/docs/vpn/api-ref/vpn_api_0030.html
@@ -1,38 +1,39 @@
Updating a VPN Connection
-FunctionThis API is used to update a VPN connection with a specified connection ID.
+
+ FunctionThis API is used to update a VPN connection with a specified connection ID.
URIPUT /v5/{project_id}/vpn-connection/{vpn_connection_id}
- Table 1 Parameter descriptionParameter
+Table 1 Parameter descriptionParameter
|
-Type
+ | Type
|
-Mandatory
+ | Mandatory
|
-Description
+ | Description
|
|---|
-project_id
+ | project_id
|
-String
+ | String
|
-Yes
+ | Yes
|
-Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID.
+ | Specifies a project ID. You can obtain the project ID by referring to Obtaining the Project ID.
|
-vpn_connection_id
+ | vpn_connection_id
|
-String
+ | String
|
-Yes
+ | Yes
|
-Specifies a VPN connection ID.
+ | Specifies a VPN connection ID.
|
@@ -40,169 +41,168 @@
Request- Request parameters
-
Table 2 Request parametersParameter
+
-Table 3 UpdateVpnConnectionRequestBodyContentParameter
+Table 3 UpdateVpnConnectionRequestBodyContentParameter
|
-Type
+ | Type
|
-Mandatory
+ | Mandatory
|
-Description
+ | Description
|
|---|
-name
+ | name
|
-String
+ | String
|
-No
+ | No
|
-- Specifies the name of a VPN connection.
- The value is a string of 1 to 64 characters, which can contain digits, letters, underscores (_), hyphens (-), and periods (.).
+ | - Specifies the name of a VPN connection.
- The value is a string of 1 to 64 characters, which can contain digits, letters, underscores (_), hyphens (-), and periods (.).
|
-cgw_id
+ | cgw_id
|
-String
+ | String
|
-No
+ | No
|
-- Specifies a customer gateway ID.
- The value is a UUID containing 36 characters.
+ | - Specifies a customer gateway ID.
- The value is a UUID containing 36 characters.
|
-peer_subnets
+ | peer_subnets
|
-Array of String
+ | Array of String
|
-No
+ | No
|
-- Specifies a customer subnet.
- Constraints:
This parameter is not required when the association mode of the VPN gateway is set to er and style is set to policy or bgp. This parameter is mandatory in other scenarios.
-Reserved VPC CIDR blocks such as 100.64.0.0/10 cannot be used as customer subnets.
-A maximum of 50 customer subnets can be configured for each VPN connection.
+- Specifies an IPv4 customer subnet.
- Constraints:
|
|
-tunnel_local_address
+ | tunnel_local_address
|
-String
+ | String
|
-No
+ | No
|
-- Specifies the tunnel interface address configured on the VPN gateway in route-based mode, for example, 169.254.76.1/30.
- Constraints:
The first 16 bits must be 169.254, and the value cannot be 169.254.195.xxx.
+- Specifies the tunnel interface address configured on the VPN gateway in route-based mode, for example, 169.254.76.1/30.
- Constraints:
The first 16 bits must be 169.254, and the value cannot be 169.254.195.xxx.
The mask length must be 30, and the address must be in the same CIDR block as the value of tunnel_peer_address.
The address needs to be a host address in a CIDR block.
|
|
-tunnel_peer_address
+ | tunnel_peer_address
|
-String
+ | String
|
-No
+ | No
|
-- Specifies the tunnel interface address configured on the customer gateway device in route-based mode, for example, 169.254.76.1/30.
- Constraints:
The first 16 bits must be 169.254, and the value cannot be 169.254.195.xxx.
+- Specifies the tunnel interface address configured on the customer gateway device in route-based mode, for example, 169.254.76.1/30.
- Constraints:
The first 16 bits must be 169.254, and the value cannot be 169.254.195.xxx.
The mask length must be 30, and the address must be in the same CIDR block as the value of tunnel_local_address.
The address needs to be a host address in a CIDR block.
|
|
-psk
+ | enable_hub
|
-String
+ | Boolean
|
-No
+ | No
|
-- Specifies a pre-shared key. When the IKE version is v2 and only this parameter is modified, the modification does not take effect.
- The value is a string of 8 to 128 characters, which must contain at least three types of the following: uppercase letters, lowercase letters, digits, and special characters (~!@#$%^()-_+={ },./:;).
+ | - Specifies whether to enable branch interconnection.
- The value can be true or false.
- The default value is false.
- Set this parameter only when style is set to BGP.
|
-policy_rules
+ | psk
|
-Array of PolicyRule objects
+ | String
|
-No
+ | No
|
-- Specifies policy rules.
- A maximum of five policy rules can be specified. Set this parameter only when style is set to policy.
-You can obtain the style value of a VPN connection by querying the VPN connection.
+ | - Specifies a pre-shared key. When the IKE version is v2 and only this parameter is modified, the modification does not take effect.
- The value is a string of 8 to 128 characters, which must contain at least three types of the following: uppercase letters, lowercase letters, digits, and special characters (~!@#$%^*()-_+={ },./:;).
|
-ikepolicy
+ | policy_rules
|
-UpdateIkePolicy object
+ | Array of PolicyRule object
|
-No
+ | No
|
-Specifies the IKE policy object.
+ | Specifies IPv4 policy rules.
+A maximum of five policy rules can be specified. This parameter is mandatory only when style is set to policy and ip_version of the VPN gateway is set to ipv4.
|
-ipsecpolicy
+ | ikepolicy
|
-UpdateIpsecPolicy object
+ | UpdateIkePolicy object
|
-No
+ | No
|
-Specifies the IPsec policy object.
+ | Specifies the IKE policy object.
+ |
+
+ipsecpolicy
+ |
+UpdateIpsecPolicy object
+ |
+No
+ |
+Specifies the IPsec policy object.
|
Table 4 PolicyRuleParameter
+Table 4 PolicyRuleParameter
|
-Type
+ | Type
|
-Mandatory
+ | Mandatory
|
-Description
+ | Description
|
|---|
-rule_index
+ | source
|
-Integer
+ | String
|
-No
+ | No
|
-- Specifies a rule ID, which is used to identify the sequence in which the rule is configured. You are advised not to set this parameter.
- The value ranges from 0 to 50.
- The value of rule_index in each policy rule must be unique. The value of rule_index in ResponseVpnConnection may be different from the value of this parameter. This is because if multiple destination CIDR blocks are specified, the VPN service generates a rule for each destination CIDR block.
+ | - The value of source in each policy rule must be unique.
|
-source
+ | destination
|
-String
+ | Array of String
|
-No
+ | No
|
-- Specifies a source CIDR block.
- The value of source in each policy rule must be unique.
- |
-
-destination
- |
-Array of String
- |
-No
- |
-- Specifies a destination CIDR block.
For example, a destination CIDR block can be 192.168.52.0/24.
+
|
|
@@ -210,168 +210,170 @@
Table 5 UpdateIkePolicyParameter
+Table 5 UpdateIkePolicyParameter
|
-Type
+ | Type
|
-Mandatory
+ | Mandatory
|
-Description
+ | Description
|
|---|
-ike_version
+ | ike_version
|
-String
+ | String
|
-No
+ | No
|
- |
-phase1_negotiation_mode
+ | phase1_negotiation_mode
|
-String
+ | String
|
-No
+ | No
|
-- Specifies the negotiation mode.
- Value range:
main: ensures high security during negotiation.
+
|
|
-authentication_algorithm
+ | authentication_algorithm
|
-String
+ | String
|
-No
+ | No
|
-- Specifies an authentication algorithm. The modification of this field takes effect only after SAs in phase 1 are aged.
- Value range:
+
- Specifies an authentication algorithm. The modification of this field takes effect only after SAs in phase 1 are aged.
- Value range:
sha2-512, sha2-384, sha2-256, sha1, md5
Exercise caution when using sha1 and md5 as they have low security.
|
|
-encryption_algorithm
+ | encryption_algorithm
|
-String
+ | String
|
-No
+ | No
|
-- Specifies an encryption algorithm. The modification of this field takes effect only after SAs in phase 1 are aged.
- Value range:
aes-256-gcm-16, aes-128-gcm-16, aes-256, aes-192, aes-128, 3des
-Exercise caution when using 3des as it has low security.
+- Specifies an encryption algorithm. The modification of this field takes effect only after SAs in phase 1 are aged.
- Value range:
aes-256-gcm-16, aes-128-gcm-16, aes-256, aes-192, aes-128, 3des
+Exercise caution when using 3des, aes-128, aes-192, and aes-256 as they have low security.
|
|
-dh_group
+ | dh_group
|
-String
+ | String
|
-No
+ | No
|
-- Specifies the DH group used for key exchange in phase 1. The modification of this field takes effect only after SAs in phase 1 are aged.
- The value can be group1, group2, group5, group14, group15, group16, group19, group20, or group21.
Exercise caution when using group1, group2, group5, or group14 as they have low security.
+
|
|
-lifetime_seconds
+ | lifetime_seconds
|
-Integer
+ | Integer
|
-No
+ | No
|
-- Specifies the SA lifetime. When the lifetime expires, an IKE SA is automatically updated. The modification of this field takes effect only after SAs in phase 1 are aged.
- The value ranges from 60 to 604800, in seconds.
+ | - Specifies the SA lifetime. When the lifetime expires, an IKE SA is automatically updated. The modification of this field takes effect only after SAs in phase 1 are aged.
- The value ranges from 60 to 604800, in seconds.
|
-local_id_type
+ | local_id_type
|
-String
+ | String
|
-No
+ | No
|
- |
-local_id
+ | local_id
|
-String
+ | String
|
-No
+ | No
|
-- Specifies the local ID.
- The value can contain a maximum of 255 case-sensitive characters, including letters, digits, and special characters (excluding & < > [ ] \). Spaces are not supported. Set this parameter when local_id_type is set to fqdn. The value must be the same as that of peer_id on the peer device.
- |
-
-peer_id_type
- |
-String
- |
-No
- |
- |
-peer_id
+ | peer_id_type
|
-String
+ | String
|
-No
+ | No
|
-- Specifies the peer ID.
- The value can contain a maximum of 255 case-sensitive characters, including letters, digits, and special characters (excluding & < > [ ] \). Spaces are not supported. Set this parameter when peer_id_type is set to fqdn. The value must be the same as that of local_id on the peer device.
+ | - Specifies the peer ID type.
- Value range:
- ip
- fqdn (currently not supported)
+
|
-dpd
+ | peer_id
|
-UpdateDpd object
+ | String
|
-No
+ | No
|
-Specifies the DPD object.
+ |
+ |
+
+dpd
+ |
+UpdateDpd object
+ |
+No
+ |
+Specifies the DPD object.
|
Table 6 UpdateDpdParameter
+Table 6 UpdateDpdParameter
|
-Type
+ | Type
|
-Mandatory
+ | Mandatory
|
-Description
+ | Description
|
|---|
-timeout
+ | timeout
|
-Integer
+ | Integer
|
-No
+ | No
|
-- Specifies the interval for retransmitting DPD packets.
- The value ranges from 2 to 60, in seconds. The default value is 15.
+ | - Specifies the interval for retransmitting DPD packets.
- The value ranges from 2 to 60, in seconds. The default value is 15.
|
-interval
+ | interval
|
-Integer
+ | Integer
|
-No
+ | No
|
-- Specifies the DPD idle timeout period.
- The value ranges from 10 to 3600, in seconds. The default value is 30.
+ | - Specifies the DPD idle timeout period.
- The value ranges from 10 to 3600, in seconds. The default value is 30.
|
-msg
+ | msg
|
-String
+ | String
|
-No
+ | No
|
-- Specifies the format of DPD packets.
- Value range:
seq-hash-notify: indicates that the payload of DPD packets is in the sequence of hash-notify.
+- Specifies the format of DPD packets.
- Value range:
seq-hash-notify: indicates that the payload of DPD packets is in the sequence of hash-notify.
seq-notify-hash: indicates that the payload of DPD packets is in the sequence of notify-hash.
The default value is seq-hash-notify.
@@ -381,73 +383,73 @@
|
|
Table 7 UpdateIpsecPolicyParameter
+Table 7 UpdateIpsecPolicyParameter
|
-Type
+ | Type
|
-Mandatory
+ | Mandatory
|
-Description
+ | Description
|
|---|
-authentication_algorithm
+ | authentication_algorithm
|
-String
+ | String
|
-No
+ | No
|
-- Specifies an authentication algorithm. Exercise caution when using SHA1 and MD5 as they have low security. The modification of this field takes effect only after SAs in phase 2 are aged.
- Value range:
sha2-512, sha2-384, sha2-256, sha1, md5
+- Specifies an authentication algorithm. Exercise caution when using SHA1 and MD5 as they have low security. The modification of this field takes effect only after SAs in phase 2 are aged.
- Value range:
sha2-512, sha2-384, sha2-256, sha1, md5
|
|
-encryption_algorithm
+ | encryption_algorithm
|
-String
+ | String
|
-No
+ | No
|
-- Specifies an encryption algorithm. Exercise caution when using 3DES as it has low security. The modification of this field takes effect only after SAs in phase 2 are aged.
- Value range:
aes-256-gcm-16, aes-128-gcm-16, aes-256, aes-192, aes-128, 3des
+- Specifies an encryption algorithm. Exercise caution when using 3des, aes-128, aes-192, and aes-256 as they have low security. The modification of this field takes effect only after SAs in phase 2 are aged.
- Value range:
aes-256-gcm-16, aes-128-gcm-16, aes-256, aes-192, aes-128, 3des
|
|
-pfs
+ | pfs
|
-String
+ | String
|
-No
+ | No
|
-- Specifies the DH key group used by PFS.
- The value can be group1, group2, group5, group14, group15, group16, group19, group20, group21, or disable. The default value is group15.
Exercise caution when using group1, group2, group5, or group14 as they have low security.
+
|
|
-transform_protocol
+ | transform_protocol
|
-String
+ | String
|
-No
+ | No
|
- |
-lifetime_seconds
+ | lifetime_seconds
|
-Integer
+ | Integer
|
-No
+ | No
|
-- Specifies the lifetime of a tunnel established over an IPsec connection. The modification of this field takes effect only after SAs in phase 2 are aged.
- The value ranges from 30 to 604800, in seconds. The default value is 3600.
+ | - Specifies the lifetime of a tunnel established over an IPsec connection. The modification of this field takes effect only after SAs in phase 2 are aged.
- The value ranges from 30 to 604800, in seconds. The default value is 3600.
|
-encapsulation_mode
+ | encapsulation_mode
|
-String
+ | String
|
-No
+ | No
|
- | |
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
