Modify the configuration of an IPsec-VPN connection with ModifyVpnConnectionAttribute - VPN Gateway - Alibaba Cloud - VPN Gateway

Modifies the configuration of an IPsec-VPN connection.

Operation description

To modify a dual-tunnel mode IPsec-VPN connection, the ModifyVpnConnectionAttribute operation supports the following request parameters in addition to the required parameters:

ClientToken, Name, LocalSubnet, RemoteSubnet, EffectImmediately, AutoConfigRoute, TunnelOptionsSpecification array, and EnableTunnelsBgp.
To modify a single-tunnel mode IPsec-VPN connection, the ModifyVpnConnectionAttribute operation supports the following request parameters in addition to the required parameters:

ClientToken, Name, LocalSubnet, RemoteSubnet, EffectImmediately, IkeConfig, IpsecConfig, HealthCheckConfig, AutoConfigRoute, EnableDpd, EnableNatTraversal, BgpConfig, and RemoteCaCertificate.
The ModifyVpnConnectionAttribute operation is asynchronous. After a request is sent, the system returns a request ID, but the configuration of the IPsec-VPN connection has not been modified yet. The modification node is still running in the background. You can invoke DescribeVpnGateway to query the instance status of the VPN gateway to determine the modification status of the IPsec-VPN connection configuration:

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:ModifyVpnConnectionAttribute

update

*VpnConnection

acs:vpc:{#regionId}:{#accountId}:vpnconnection/{#VpnConnectionId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the IPsec-VPN connection. You can call the DescribeRegions operation to query the region ID.	cn-shanghai
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId of each API request is different.	02fb3da4-130e-11e9-8e44-0016e04115b
VpnConnectionId	string	Yes	The ID of the IPsec-VPN connection.	vco-bp1bbi27hojx80nck****
Name	string	No	The name of the IPsec-VPN connection. The name must be 1 to 100 characters in length and cannot start with `http://` or `https://`.	nametest
LocalSubnet	string	No	The CIDR block on the VPC side that needs to communicate with the on-premises data center. This is used for Phase 2 negotiation. Separate multiple CIDR blocks with commas (,). Example: 192.168.1.0/24,192.168.2.0/24. Description of the routing mode for the IPsec-VPN connection: If both LocalSubnet and RemoteSubnet are set to 0.0.0.0/0, the destination routing mode is used. If both LocalSubnet and RemoteSubnet are set to specific CIDR blocks, the protected data flow mode is used.	10.1.1.0/24,10.1.2.0/24
RemoteSubnet	string	No	The CIDR block of the on-premises data center, used for Phase 2 negotiation. Separate multiple CIDR blocks with commas (,). Example: 192.168.3.0/24,192.168.4.0/24. Description of the IPsec-VPN connection routing mode: If both LocalSubnet and RemoteSubnet are set to 0.0.0.0/0, the destination routing mode is used. If both LocalSubnet and RemoteSubnet are set to specific CIDR blocks, the protected data flow mode is used.	10.2.1.0/24,10.2.2.0/24
EffectImmediately	boolean	No	Specifies whether the configuration of the IPsec-VPN connection takes effect immediately. Valid values:	false
IkeConfig	string	No	This parameter is supported when you modify an IPsec-VPN connection in single-tunnel mode. The configuration of Phase 1 negotiation: IkeConfig.Psk: The pre-shared key used for identity authentication between the VPN gateway and the on-premises data center. The key must be 1 to 100 characters in length and can contain digits, uppercase letters, lowercase letters, and the following characters. It cannot contain spaces. ~!`@#$%^&()_-+={}[]\|;:',.<>/? If you do not specify a pre-shared key, the system generates a random 16-character string as the pre-shared key. You can call the DescribeVpnConnection operation to query the pre-shared key that is automatically generated by the system. Note* The pre-shared key on the IPsec-VPN connection side must be the same as the authentication key on the on-premises data center side. Otherwise, a connection cannot be established between the on-premises data center and the VPN gateway. IkeConfig.IkeVersion: The version of the Internet Key Exchange protocol. Valid values: ikev1 and ikev2. Compared with IKEv1, IKEv2 simplifies the SA negotiation process and provides better support for multi-CIDR-block scenarios. IkeConfig.IkeMode: The negotiation mode of the IKE version. Valid values: main and aggressive. main: Main mode. This mode offers high security during negotiations. aggressive: Aggressive mode. This mode supports rapid negotiations and a higher success rate. IkeConfig.IkeEncAlg: The encryption algorithm used in Phase 1 negotiation. Valid values: aes, aes192, aes256, des, and 3des. IkeConfig.IkeAuthAlg: The authentication algorithm used in Phase 1 negotiation. Valid values: md5, sha1, sha256, sha384, and sha512. IkeConfig.IkePfs: The Diffie-Hellman key exchange algorithm used in Phase 1 negotiation. Valid values: group1, group2, group5, and group14. IkeConfig.IkeLifetime: The lifetime of the SA negotiated in Phase 1. Unit: seconds. Valid values: 0 to 86400. IkeConfig.LocalId: The identifier of the VPN gateway. The value can be up to 100 characters in length and cannot contain spaces. Default value: the IP address of the VPN gateway. IkeConfig.RemoteId: The identifier of the customer gateway. The value can be up to 100 characters in length and cannot contain spaces. Default value: the IP address of the customer gateway.	{"Psk":"pgw6dy7d1i8i****","IkeVersion":"ikev1","IkeMode":"main","IkeEncAlg":"aes","IkeAuthAlg":"sha1","IkePfs":"group2","IkeLifetime":86400,"LocalId":"116.64.XX.XX","RemoteId":"139.18.XX.XX"}
IpsecConfig	string	No	This parameter is supported when you modify a single-tunnel IPsec-VPN connection. The configuration of Phase 2 negotiation: IpsecConfig.IpsecEncAlg: The encryption algorithm used in Phase 2 negotiation. Valid values: aes, aes192, aes256, des, or 3des. IpsecConfig.IpsecAuthAlg: The authentication algorithm used in Phase 2 negotiation. Valid values: md5, sha1, sha256, sha384, sha512. IpsecConfig.IpsecPfs: The Diffie-Hellman key exchange algorithm used in Phase 1 negotiation for forwarding packets of all protocols. Valid values: disabled, group1, group2, group5, group14. IpsecConfig.IpsecLifetime: The lifetime of the SA established in Phase 2 negotiation. Unit: seconds. Valid values: 0 to 86400.	{"IpsecEncAlg":"aes","IpsecAuthAlg":"sha1","IpsecPfs":"group2","IpsecLifetime":86400}
HealthCheckConfig	string	No	This parameter is supported when you modify a single-tunnel mode IPsec-VPN connection.	{"enable":"true","dip":"192.168.1.1","sip":"10.1.1.1","interval":"3","retry":"3"}
AutoConfigRoute	boolean	No	Specifies whether to automatically publish routing. Valid values:	true
EnableDpd	boolean	No	This parameter is supported when you modify a single-tunnel IPsec-VPN connection. Specifies whether to enable the Dead Peer Detection (DPD) feature. Valid values: true: Enables the DPD feature. The IPsec initiator sends DPD packets to check whether the peer device is alive. If no correct response is received within the specified period of time, the peer is considered disconnected. The ISAKMP SA and the corresponding IPsec SA are deleted, and the security tunnel is also deleted. false: Disables the DPD feature. The IPsec initiator does not send DPD packets.	true
EnableNatTraversal	boolean	No	This parameter is supported when you modify an IPsec-VPN connection in single-tunnel mode. Specifies whether to enable NAT traversal. Valid values: true: Enable NAT traversal. After NAT traversal is enabled, the verification of the UDP port number is removed during IKE negotiation, and NAT gateway devices in the VPN tunnel can be discovered. false: Disable NAT traversal.	true
BgpConfig	string	No	This parameter is supported when you modify an IPsec-VPN connection in single-tunnel mode. The BGP configuration: BgpConfig.EnableBgp: specifies whether to enable BGP. Valid values: true or false. BgpConfig.LocalAsn: the autonomous system number on the Alibaba Cloud side. Valid values: 1 to 4294967295. You can enter the autonomous system number in two-segment notation: the first 16 bits.the last 16 bits. Each segment is entered in decimal format. For example, if you enter 123.456, the autonomous system number is 123 × 65536 + 456 = 8061384. BgpConfig.TunnelCidr: the CIDR block of the IPsec tunnel. The CIDR block must be a /30 CIDR block within 169.254.0.0/16 and cannot be 169.254.0.0/30, 169.254.1.0/30, 169.254.2.0/30, 169.254.3.0/30, 169.254.4.0/30, 169.254.5.0/30, 169.254.6.0/30, or 169.254.169.252/30. Note The IPsec tunnel CIDR block of each IPsec-VPN connection under a VPN gateway instance must be unique. LocalBgpIp: the BGP IP address on the Alibaba Cloud side. This address is an IP address within the IPsec tunnel CIDR block. Note Configure this parameter when BGP dynamic routing is enabled on your VPN gateway. Before you configure BGP, we recommend that you learn about how BGP dynamic routing works and its limits. For more information, see Configure BGP dynamic routing. We recommend that you use a private autonomous system number to establish a BGP connection with Alibaba Cloud. For the range of private autonomous system numbers, refer to the relevant documentation.	{"EnableBgp":"true","LocalAsn":"65530","TunnelCidr":"169.254.11.0/30","LocalBgpIp":"169.254.11.1"}
RemoteCaCertificate	string	No	This parameter is supported when you modify a single-tunnel mode IPsec-VPN connection.	-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----
TunnelOptionsSpecification	array<object>	No	The tunnel configurations to modify.
	array<object>	No	The tunnel configuration to modify.
TunnelId	string	No	The tunnel ID.	tun-opsqc4d97wni27****
CustomerGatewayId	string	No	The instance ID of the customer gateway associated with the tunnel.	cgw-1nmwbpgrp7ssqm1yn****
Role	string	No	The role of the tunnel.	master
EnableDpd	boolean	No	Specifies whether to enable the Dead Peer Detection (DPD) feature for the tunnel. Valid values:	true
EnableNatTraversal	boolean	No	Specifies whether to enable NAT traversal for the tunnel. Valid values: true: Enables NAT traversal. After NAT traversal is enabled, the IKE negotiation process skips UDP port verification and can discover NAT gateway devices in the VPN tunnel. false: Disables NAT traversal.	true
RemoteCaCertificate	string	No	If the current VPN gateway instance is a Chinese SM-based VPN gateway, you can modify the peer CA certificate for the tunnel.	-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----
TunnelBgpConfig	object	No	The BGP configuration of the tunnel to modify.
LocalAsn	integer	No	The autonomous system number (ASN) on the Alibaba Cloud side of the tunnel. Valid values: 1 to 4294967295. Default value: 45104. Note This parameter can be configured or modified after you enable BGP for the IPsec-VPN connection (by setting EnableTunnelsBgp to true). Before configuring BGP, we recommend that you understand the working mechanism and limits of BGP dynamic routing. For more information, see Configure BGP dynamic routing. Use a private ASN to establish BGP connections with Alibaba Cloud. Refer to the relevant documentation for the private ASN ranges.	65530
LocalBgpIp	string	No	The BGP IP address on the Alibaba Cloud side. This address is an IP address within the BGP CIDR block.	169.254.10.1
TunnelCidr	string	No	The BGP CIDR block of the tunnel. The CIDR block must be a /30 CIDR block within 169.254.0.0/16, and cannot be 169.254.0.0/30, 169.254.1.0/30, 169.254.2.0/30, 169.254.3.0/30, 169.254.4.0/30, 169.254.5.0/30, 169.254.6.0/30, or 169.254.169.252/30. Note Within a VPN gateway instance, the BGP CIDR block of each tunnel must be unique.	169.254.10.0/30
TunnelIkeConfig	object	No	The Phase 1 negotiation configuration.
IkeAuthAlg	string	No	The authentication algorithm for Phase 1 negotiation.	md5
IkeEncAlg	string	No	The encryption algorithm used in Phase 1 negotiations. Valid values: aes, aes192, aes256, des, or 3des.	aes
IkeLifetime	integer	No	The lifetime of the security association (SA) generated by Phase 1 negotiation. Unit: seconds. Valid values: 0 to 86400.	86400
IkeMode	string	No	The negotiation mode of the IKE version. Valid values:	main
IkePfs	string	No	The Diffie-Hellman key exchange algorithm used in Phase 1 negotiation. Valid values: group1, group2, group5, and group14.	group2
IkeVersion	string	No	The version of the IKE protocol. Valid values: ikev1 and ikev2.	ikev1
LocalId	string	No	The identifier on the Alibaba Cloud side for Phase 1 negotiation. The value can be up to 100 characters in length and cannot contain spaces. The default value is the IP address of the tunnel.	47.21.XX.XX
Psk	string	No	The pre-shared key, which is used for identity authentication between the tunnel and the tunnel peer. The key must be 1 to 100 characters in length and can contain digits, uppercase letters, lowercase letters, and the following characters. It cannot contain spaces. ~!\`@#$%^&()_-+={}[]\|;:',.<>/? If you do not specify a pre-shared key, the system randomly generates a 16-character string as the pre-shared key. You can call the DescribeVpnConnection operation to query the pre-shared key automatically generated by the system. Note* The pre-shared keys of the tunnel and the tunnel peer must be the same. Otherwise, the tunnel cannot be established.	123456****
RemoteId	string	No	The identifier of the tunnel peer for Phase 1 negotiation. The value can be up to 100 characters in length and cannot contain spaces. The default value is the IP address of the customer gateway associated with the tunnel.	47.42.XX.XX
TunnelIpsecConfig	object	No	The Phase 2 negotiation configuration.
IpsecAuthAlg	string	No	The authentication algorithm for Phase 2 negotiation.	md5
IpsecEncAlg	string	No	The encryption algorithm used in Phase 2 negotiations. Valid values: aes, aes192, aes256, des, or 3des.	aes
IpsecLifetime	integer	No	The lifetime of the SA generated by Phase 2 negotiation. Unit: seconds. Valid values: 0 to 86400.	86400
IpsecPfs	string	No	The Diffie-Hellman key exchange algorithm used in the second phase of negotiation. Valid values: disabled, group1, group2, group5, group14.	group2
EnableTunnelsBgp	boolean	No	This parameter is supported when you modify a dual-tunnel IPsec-VPN connection. Specifies whether to enable BGP for the tunnel. Valid values: true or false.	true

Response elements

Element	Type	Description	Example
	object	The response parameters.
EnableNatTraversal	boolean	Indicates whether NAT traversal is enabled for the IPsec-VPN connection. Valid values:	true
CreateTime	integer	The timestamp when the IPsec-VPN connection was created. Unit: milliseconds. The timestamp is in the UNIX timestamp format, which represents the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1492753817000
EffectImmediately	boolean	Indicates whether the IPsec-VPN connection configuration takes effect immediately. true: The system immediately initiates IPsec protocol negotiation after the configuration is complete. false: The system initiates IPsec protocol negotiation only when traffic enters.	false
VpnGatewayId	string	The ID of the VPN gateway instance.	vpn-bp1q8bgx4xnkm2ogj****
LocalSubnet	string	The CIDR block on the VPC side.	10.1.1.0/24,10.1.2.0/24
RequestId	string	The request ID.	7DB79D0C-5F27-4AB5-995B-79BE55102F90
VpnConnectionId	string	The ID of the IPsec-VPN connection.	vco-bp1bbi27hojx80nck****
Description	string	The description of the IPsec-VPN connection.	description
RemoteSubnet	string	The CIDR block on the on-premises data center side.	10.2.1.0/24,10.2.2.0/24
CustomerGatewayId	string	The ID of the customer gateway associated with the IPsec-VPN connection.	cgw-p0w2jemrcj5u61un8****
Name	string	The name of the IPsec-VPN connection.	nametest
EnableDpd	boolean	Indicates whether Dead Peer Detection (DPD) is enabled for the IPsec-VPN connection. false: Not enabled. true: Enabled. This parameter is returned only for IPsec-VPN connections in single-tunnel mode.	true
IkeConfig	object	The configuration of Phase 1 negotiation.
RemoteId	string	The identifier on the on-premises data center side. FQDN and IP formats are supported. The default value is the IP address of the selected customer gateway.	139.18.XX.XX
IkeLifetime	integer	The lifetime of the IKE phase. Unit: seconds.	86400
IkeEncAlg	string	The encryption algorithm of the IKE phase.	aes
LocalId	string	The identifier on the VPC side. FQDN and IP formats are supported. The default value is the IP address of the selected VPN gateway.	116.64.XX.XX
IkeMode	string	The IKE negotiation mode. main: Main mode. The negotiation process is highly secure. aggressive: Aggressive mode. Negotiation is fast and has a high success rate.	main
IkeVersion	string	The IKE protocol version. ikev1 ikev2 Compared with IKEv1, IKEv2 simplifies the SA negotiation process and provides better support for multi-CIDR-block scenarios.	ikev1
IkePfs	string	The DH group of the IKE phase.	group2
Psk	string	The pre-shared key.	pgw6dy7d1i8i****
IkeAuthAlg	string	The authentication algorithm of the IKE phase.	sha1
IpsecConfig	object	The configuration of Phase 2 negotiation.
IpsecAuthAlg	string	The authentication algorithm of the IPsec phase.	sha1
IpsecLifetime	integer	The lifetime of the IPsec phase. Unit: seconds.	86400
IpsecEncAlg	string	The encryption algorithm of the IPsec phase.	aes
IpsecPfs	string	The DH group of the IPsec phase.	group2
VcoHealthCheck	object	The health check configuration. Parameters in the VcoHealthCheck array are returned only for IPsec-VPN connections in single-tunnel mode.
Dip	string	The destination IP address.	192.168.1.1
Interval	integer	The retry interval of the health check. Unit: seconds.	3
Retry	integer	The number of retry packets sent during the health check.	3
Sip	string	The source IP address.	10.1.1.1
Enable	string	Indicates whether the health check feature is enabled for the IPsec-VPN connection.	true
VpnBgpConfig	object	The BGP configuration.
Status	string	The BGP negotiation status.	success
PeerBgpIp	string	The BGP address on the on-premises data center side.	169.254.11.2
TunnelCidr	string	The BGP CIDR block of the IPsec-VPN connection.	169.254.11.0/30
EnableBgp	string	The enabling status of BGP.	true
LocalBgpIp	string	The BGP address on the Alibaba Cloud side.	169.254.11.1
PeerAsn	integer	The autonomous system number on the on-premises data center side.	65531
LocalAsn	integer	The autonomous system number on the Alibaba Cloud side.	65530
TunnelOptionsSpecification	object
TunnelOptions	array<object>	The tunnel configuration of the IPsec-VPN connection.
	array<object>	The tunnel configuration.
CustomerGatewayId	string	The ID of the customer gateway associated with the tunnel.	cgw-p0wy363lucf1uyae8****
EnableDpd	boolean	Indicates whether the DPD (Dead Peer Detection) feature is enabled for the tunnel. false: Not enabled. true: Enabled.	true
EnableNatTraversal	boolean	Indicates whether NAT traversal is enabled for the tunnel. false: Not enabled. true: Enabled.	true
InternetIp	string	The gateway IP address on the Alibaba Cloud side of the tunnel.	47.21.XX.XX
RemoteCaCertificate	string	The CA certificate of the peer end of the tunnel. This parameter is returned only when the VPN gateway instance uses the China Certification encryption algorithm.	-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----
Role	string	The role of the tunnel. Valid values: master: The tunnel is the active tunnel. slave: The tunnel is the standby tunnel.	master
State	string	The status of the tunnel. active: Normal. updating: Being updated. deleting: Being deleted.	active
TunnelBgpConfig	object	The BGP configuration of the tunnel.
LocalAsn	integer	The autonomous system number on the Alibaba Cloud side of the tunnel.	65530
LocalBgpIp	string	The BGP address on the Alibaba Cloud side of the tunnel.	169.254.10.1
PeerAsn	integer	The autonomous system number of the peer end of the tunnel.	65531
PeerBgpIp	string	The BGP address of the peer end of the tunnel.	169.254.10.2
TunnelCidr	string	The BGP CIDR block of the tunnel.	169.254.10.0/30
TunnelId	string	The tunnel ID.	tun-opsqc4d97wni27****
TunnelIkeConfig	object	The configuration of Phase 1 negotiation.
IkeAuthAlg	string	The IKE phase authentication algorithm.	sha1
IkeEncAlg	string	The IKE phase encryption algorithm.	aes
IkeLifetime	integer	The IKE phase lifetime. Unit: seconds.	86400
IkeMode	string	The IKE negotiation mode. main: Main mode. This mode offers high security during negotiation. aggressive: Aggressive mode. This mode supports fast negotiation and a higher success rate.	main
IkePfs	string	The DH group in the IKE phase.	group2
IkeVersion	string	The IKE protocol version.	ikev1
LocalId	string	The identifier on the Alibaba Cloud side of the tunnel.	47.21.XX.XX
Psk	string	The pre-shared key.	123456****
RemoteId	string	The identifier of the peer end of the tunnel.	47.42.XX.XX
TunnelIpsecConfig	object	The configuration of Phase 2 negotiation.
IpsecAuthAlg	string	The IPsec phase authentication algorithm.	sha1
IpsecEncAlg	string	The IPsec phase encryption algorithm.	aes
IpsecLifetime	integer	The IPsec phase lifetime. Unit: seconds.	86400
IpsecPfs	string	The DH group in the IPsec phase.	group2
ZoneNo	string	The zone in which the tunnel is deployed.	ap-southeast-5a
EnableTunnelsBgp	boolean	The BGP status of the tunnel. true: enabled. false: disabled. This parameter is returned only for IPsec-VPN connections in dual-tunnel mode.	true
ResourceGroupId	string	The ID of the resource group to which the IPsec-VPN connection belongs.	rg-acfmzs372yg****

Examples

Success response

JSON format

{
  "EnableNatTraversal": true,
  "CreateTime": 1492753817000,
  "EffectImmediately": false,
  "VpnGatewayId": "vpn-bp1q8bgx4xnkm2ogj****",
  "LocalSubnet": "10.1.1.0/24,10.1.2.0/24",
  "RequestId": "7DB79D0C-5F27-4AB5-995B-79BE55102F90",
  "VpnConnectionId": "vco-bp1bbi27hojx80nck****",
  "Description": "description",
  "RemoteSubnet": "10.2.1.0/24,10.2.2.0/24",
  "CustomerGatewayId": "cgw-p0w2jemrcj5u61un8****",
  "Name": "nametest",
  "EnableDpd": true,
  "IkeConfig": {
    "RemoteId": "139.18.XX.XX",
    "IkeLifetime": 86400,
    "IkeEncAlg": "aes",
    "LocalId": "116.64.XX.XX",
    "IkeMode": "main",
    "IkeVersion": "ikev1",
    "IkePfs": "group2",
    "Psk": "pgw6dy7d1i8i****",
    "IkeAuthAlg": "sha1"
  },
  "IpsecConfig": {
    "IpsecAuthAlg": "sha1",
    "IpsecLifetime": 86400,
    "IpsecEncAlg": "aes",
    "IpsecPfs": "group2"
  },
  "VcoHealthCheck": {
    "Dip": "192.168.1.1",
    "Interval": 3,
    "Retry": 3,
    "Sip": "10.1.1.1",
    "Enable": "true"
  },
  "VpnBgpConfig": {
    "Status": "success",
    "PeerBgpIp": "169.254.11.2",
    "TunnelCidr": "169.254.11.0/30",
    "EnableBgp": "true",
    "LocalBgpIp": "169.254.11.1",
    "PeerAsn": 65531,
    "LocalAsn": 65530
  },
  "TunnelOptionsSpecification": {
    "TunnelOptions": [
      {
        "CustomerGatewayId": "cgw-p0wy363lucf1uyae8****",
        "EnableDpd": true,
        "EnableNatTraversal": true,
        "InternetIp": "47.21.XX.XX",
        "RemoteCaCertificate": "-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----",
        "Role": "master",
        "State": "active",
        "TunnelBgpConfig": {
          "LocalAsn": 65530,
          "LocalBgpIp": "169.254.10.1",
          "PeerAsn": 65531,
          "PeerBgpIp": "169.254.10.2",
          "TunnelCidr": "169.254.10.0/30"
        },
        "TunnelId": "tun-opsqc4d97wni27****",
        "TunnelIkeConfig": {
          "IkeAuthAlg": "sha1",
          "IkeEncAlg": "aes",
          "IkeLifetime": 86400,
          "IkeMode": "main",
          "IkePfs": "group2",
          "IkeVersion": "ikev1",
          "LocalId": "47.21.XX.XX",
          "Psk": "123456****",
          "RemoteId": "47.42.XX.XX"
        },
        "TunnelIpsecConfig": {
          "IpsecAuthAlg": "sha1",
          "IpsecEncAlg": "aes",
          "IpsecLifetime": 86400,
          "IpsecPfs": "group2"
        },
        "ZoneNo": "ap-southeast-5a"
      }
    ]
  },
  "EnableTunnelsBgp": true,
  "ResourceGroupId": "rg-acfmzs372yg****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	VpnGateway.Configuring	The specified service is configuring.
400	VpnGateway.FinancialLocked	The specified service is financial locked.
400	InvalidName	The name is not valid
400	VpnRouteEntry.AlreadyExists	The specified route entry is already exist.	The route already exists.
400	VpnRouteEntry.Conflict	The specified route entry has conflict.	Route conflicts exist.
400	NotSupportVpnConnectionParameter.IpsecPfs	The specified vpn connection ipsec Ipsec Pfs is not support.	The PFS parameter set for the IPsec-VPN connection is not supported.
400	NotSupportVpnConnectionParameter.IpsecAuthAlg	The specified vpn connection ipsec Auth Alg is not support.	The authentication algorithm specified for the IPsec-VPN connection is not supported.
400	VpnRouteEntry.ConflictSSL	The specified route entry has conflict with SSL client.	The route conflicts with the SSL client.
400	VpnRouteEntry.BackupRoute	Validate backup route entry failed.	Active/standby routes failed authentication.
400	VpnRouteEntry.InvalidWeight	Invalid route entry weight value.	The weight specified for the route is invalid.
400	QuotaExceeded.PBR	The policy-based routes has reached the upper limit.	The number of policy-based routes has reached the upper limit.
400	OperationUnsupported.SetDPD	Current version of the VPN does not support setting DPD.	The VPN gateway version does not support DPD.
400	OperationUnsupported.SetNatTraversal	Current version of the VPN does not support setting NAT traversal.	The VPN gateway version does not support NAT traversal.
400	QuotaExceeded.PolicyBasedRoute	The maximum number of policy-based routes is exceeded. Existing routes: %s. Routes to be created: %s. Maximum routes: %s.	The quota of policy-based routes is reached. Existing routes: %s. Routes to be created: %s. Quota: %s.
400	MissingParameter.TunnelCidr	The parameter TunnelCidr is mandatory when BGP is enabled.	You must specify the tunnel CIDR block when you enable BGP.
400	OperationUnsupported.EnableBgp	Current version of the VPN does not support enable BGP.	The current version of the VPN gateway does not support BGP.
400	MissingParam.CustomerGatewayAsn	Asn of customer gateway is mandatory when BGP is enabled.	The ASN of the customer gateway cannot be empty when you enable BGP.
400	IllegalParam.LocalAsn	The specified LocalAsn is invalid.	The local ASN is invalid.
400	IllegalParam.BgpConfig	The specified BgpConfig is invalid.	The BGP configuration is invalid.
400	IllegalParam.EnableBgp	VPN connection must enable BGP when VPN gateway has enabled BGP.	The error message returned because the VPN connection must use BGP if BGP is enabled for the VPN gateway.
400	IllegalParam.TunnelCidr	The specified TunnelCidr is invalid.	The TunnelCidr parameter is set to an invalid value.
400	InvalidLocalBgpIp.Malformed	The specified LocalBgpIp is malformed.	The local BGP IP address is in an abnormal state.
400	IllegalParam.LocalBgpIp	The specified LocalBgpIp is invalid.	The local BGP IP address is invalid.
400	IllegalParam.LocalSubnet	The specified "LocalSubnet" (%s) is invalid.	The specified "LocalSubnet" (%s) is invalid.
400	IllegalParam.RemoteSubnet	The specified "RemoteSubnet" (%s) is invalid.	The specified "RemoteSubnet" (%s) is invalid.
400	OperationFailed.CenLevelNotSupport	When the VPC to which the VPN gateway belongs is attached to a FULL-mode CEN, the VPN gateway cannot enable BGP.	When the VPC to which the VPN gateway belongs is attached to a FULL-mode CEN, the VPN gateway cannot enable BGP.
400	InvalidTunnelCidr.Malformed	The specified TunnelCidr is malformed.	The specified tunnel CIDR block is invalid.
400	CustomerGateway.ConflictRouteEntry	The specified customer gateway has conflict with route entry.	The customer gateway conflicts with the current routes.
400	VpnTask.CONFLICT	Vpn task has conflict.	The VPN operation conflicts. Try again later.
400	OperationFailed.RouteConflictWithIPsecServer	Operation failed because the route to create conflicts with the client IP pool of the IPsec server.	Operation failed because the route to create conflicts with the client IP pool of the IPsec server.
400	IllegalParam.TunnelId	The specified TunnelId is invalid.	TunnelId is set to an invalid value.
400	IllegalParam.Role	The specified Role is invalid.	Role is set to an invalid value.
400	VpnConnectionParamInvalid.SameVpnAndCgwDifferentIkeConfigs	IPSec connections associated with the same user gateway and VPN gateway should have the same pre-shared key and IKE configuration.	The pre-shared key and IKE parameters must be the same for IPsec-VPN connections that are associated with the same VPN gateway and customer gateway.
400	VpnConnectionParamInvalid.SameVpnAndCgwTrafficSelectorOverlap	Traffic selectors of IPSec connections associated with the same user gateway and VPN gateway should not overlap.	The protected data flows of IPsec-VPN connections that are associated with the same VPN gateway and customer gateway cannot overlap.
400	ModifyIkeV1WithMultiRoutes.Invalid	Failed to modify VPN connection parameters. Multi-network is configured while using IkeV1 protocol.	Failed to modify VPN connection parameters. Multi-network is configured while using IkeV1 protocol.
400	Vco.StatusNotSupport	The current VPN connection state does not support this operation.	The operation cannot be performed when the VPN connection is in the current state.
400	IkeVersionInvalid.GcmIncompatible	Ikev1 does not support IkeEncAlg of gcm16.	Ikev1 does not support IkeEncAlg of gcm16.
400	EncAlgInvalid.DesIncompatible	Des/3des in IkeEncAlg and IpsecEncAlg does not support multi algorithm.	Des/3des in IkeEncAlg and IpsecEncAlg does not support multi algorithm.
400	CustomerGateway.ConflictVpnIp	The specified customer gateway has conflict with vpn gateway ip.	The specified customer gateway has conflict with vpn gateway ip.
400	CustomerGateway.AsnNotConfigured	ASN of CustomerGateway is required when enabling BGP on an IPSec connection.	When BGP is enabled for IPSec connection, ASN needs to be configured on the customer gateway.
500	OperationFailed.RouteConflictWithIPsecServer	Operation failed because the specified route conflicts with IPsec server.	The route conflicts with the IPsec server.
403	Forbbiden.SubUser	User not authorized to operate on the specified resource as your account is created by another user.
403	Forbidden	User not authorized to operate on the specified resource.	You do not have the permissions to manage the specified resource. Apply for the permissions and try again.
404	InvalidVpnConnectionInstanceId.NotFound	The specified vpn connection instance id does not exist.	The specified vpn connection instance id does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.