DescribeVpnConnections - Virtual Private Cloud - Alibaba Cloud Documentation Center

Queries IPsec-VPN connections.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
vpc:DescribeVpnConnections	list	VpnConnection acs:vpc:{#regionId}:{#accountId}:vpnconnection/* VpnConnection acs:vpc:{#regionId}:{#accountId}:vpnconnection/{#VpnConnectionId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the IPsec-VPN connection is created. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
VpnGatewayId	string	No	The ID of the VPN gateway.	vpn-bp1q8bgx4xnkx****
CustomerGatewayId	string	No	The ID of the customer gateway.	cgw-bp1mvj4g9kogw****
PageNumber	integer	No	The number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 10. Valid values: 1 to 50.	10
VpnConnectionId	string	No	The ID of the IPsec-VPN connection.	vco-bp10lz7aejumd****
Tag	array<object>	No	The tag value. The tag value can be an empty string and cannot exceed 128 characters in length. It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`. Each tag key corresponds to one tag value. You can specify up to 20 tag values in each call.
	object	No	The tag value.
Key	string	No	The tag key. The tag key cannot be an empty string. It can be at most 64 characters in length, and cannot contain `http://` or `https://`. It cannot start with `aliyun` or `acs:`. You can specify at most 20 tag keys in each call.	TagKey
Value	string	No	The tag value. The tag value can be an empty string and cannot exceed 128 characters in length. It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`. Each tag key corresponds to one tag value. You can specify at most 20 tag values in each call.	TagValue
ResourceGroupId	string	No	The ID of the resource group to which the IPsec-VPN connection belongs. You can call the ListResourceGroups operation to query the resource group ID.	rg-acfmzs372yg****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
PageSize	integer	The number of entries returned per page.	10
RequestId	string	The request ID.	238752DC-0693-49BE-9C85-711D5691D3E5
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of entries returned.	2
VpnConnections	array<object>	The information about the IPsec-VPN connection.
VpnConnection	object
Status	string	The status of the IPsec-VPN connection. Valid values: ike_sa_not_established: Phase 1 negotiations failed. ike_sa_established: Phase 1 negotiations succeeded. ipsec_sa_not_established: Phase 2 negotiations failed. ipsec_sa_established: Phase 2 negotiations succeeded.	ipsec_sa_established
EnableNatTraversal	boolean	Indicates whether NAT traversal is enabled for the IPsec-VPN connection. true After NAT traversal is enabled, the initiator does not check the UDP ports during IKE negotiations and can automatically discover NAT gateway devices along the IPsec tunnel. false	true
RemoteCaCertificate	string	The certificate authority (CA) certificate of the peer.	-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----
CreateTime	long	The timestamp generated when the IPsec-VPN connection was established. Unit: milliseconds. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.	1492753817000
EffectImmediately	boolean	Indicates whether IPsec negotiations immediately start. true: Negotiations are reinitiated after the configuration is changed. false: Negotiations are reinitiated after traffic is detected.	true
VpnGatewayId	string	The ID of the VPN gateway.	vpn-bp1q8bgx4xnkm****
LocalSubnet	string	The CIDR block on the Alibaba Cloud side. Multiple CIDR blocks are separated by commas (,).	192.168.0.0/16,172.17.0.0/16
VpnConnectionId	string	The ID of the IPsec-VPN connection.	vco-bp10lz7aejumd****
RemoteSubnet	string	The CIDR block of the data center. Multiple CIDR blocks are separated by commas (,).	10.0.0.0/8,172.16.0.0/16
CustomerGatewayId	string	The ID of the customer gateway associated with the IPsec-VPN connection.	cgw-bp1mvj4g9kogw****
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. Valid values: true The initiator of the IPsec-VPN connection sends DPD packets to check the existence and availability of the peer. If no feedback is received from the peer within a specific period of time, the connection fails. Then, the ISAKMP security association (SA), IPsec SA, and IPsec tunnel are deleted. false	true
IkeConfig	object	The configurations of Phase 1 negotiations.
RemoteId	string	The identifier of the IPsec-VPN connection on the Alibaba Cloud side.	139.17.XX.XX
IkeLifetime	long	The lifetime in the IKE phase. Unit: seconds.	86400
IkeEncAlg	string	The encryption algorithm in the IKE phase.	aes
LocalId	string	The identifier of the IPsec-VPN connection on the data center side.	116.64.XX.XX
IkeMode	string	The IKE negotiation mode. main: This mode offers higher security during negotiations. aggressive: This mode is faster and has a higher success rate.	main
IkeVersion	string	The version of the IKE protocol. ikev1 ikev2 Compared with IKEv1, IKEv2 simplifies the SA negotiation process and is more suitable for scenarios in which multiple CIDR blocks are used.	ikev1
IkePfs	string	The DH group in the IKE phase.	group2
Psk	string	The pre-shared key.	pgw6dy7****
IkeAuthAlg	string	The authentication algorithm in the IKE phase.	sha1
IpsecConfig	object	The configurations of Phase 2 negotiations.
IpsecAuthAlg	string	The authentication algorithm in the IPsec phase.	sha1
IpsecLifetime	long	The lifetime in the IPsec phase. Unit: seconds.	86400
IpsecEncAlg	string	The encryption algorithm in the IPsec phase.	aes
IpsecPfs	string	The DH group in the IPsec phase.	group2
VcoHealthCheck	object	The health check configuration of the IPsec-VPN connection.
Status	string	The state of the health check. Valid values: success failed	success
Dip	string	The destination IP address.	192.168.0.1
Interval	integer	The interval between two consecutive health checks. Unit: seconds.	2
Retry	integer	The maximum number of health check retries.	3
Sip	string	The source IP address.	192.168.0.50
Enable	string	Indicates whether the health check feature is enabled. true false	true
Policy	string	Indicates whether advertised routes are withdrawn when the health check fails. revoke_route: Advertised routes are withdrawn. reserve_route: Advertised routes are not withdrawn.	revoke_route
VpnBgpConfig	object	The BGP configuration of the IPsec-VPN connection.
Status	string	The negotiation state of the BGP routing protocol. Valid values: success false	success
PeerBgpIp	string	The BGP IP address of the peer.	169.254.10.1
TunnelCidr	string	The BGP CIDR block of the IPsec-VPN connection. The CIDR block falls within 169.254.0.0/16. The subnet mask of the CIDR block must be 30 bits in length.	169.254.10.0/30
LocalBgpIp	string	The BGP IP address on the Alibaba Cloud side.	169.254.10.2
PeerAsn	long	The ASN of the peer.	65530
LocalAsn	long	The ASN on the Alibaba Cloud side.	65531
AuthKey	string	The authentication key of the BGP routing protocol.	AuthKey****
AttachType	string	The type of resource that is associated with the IPsec-VPN connection. Valid values: CEN: indicates that the IPsec-VPN connection is associated with a transit router of a Cloud Enterprise Network (CEN) instance. NO_ASSOCIATED: indicates that the IPsec-VPN connection is not associated with any resource. VPNGW: indicates that the IPsec-VPN connection is associated with a VPN gateway.	CEN
NetworkType	string	The network type of the IPsec-VPN connection. Valid values: public private	public
AttachInstanceId	string	The ID of the CEN instance to which the transit router belongs.	cen-lxxpbpalc776qz****
Spec	string	The bandwidth specification of the IPsec-VPN connection. Unit: Mbit/s.	1000M
State	string	The association state of the IPsec-VPN connection. Valid values: active: The IPsec-VPN connection is associated with a VPN gateway. init: The IPsec-VPN connection is not associated with any resource and is being initialized. attaching: The IPsec-VPN connection is being associated with a transit router. attached: The IPsec-VPN connection is associated with a transit router. detaching: The IPsec-VPN connection is being disassociated from a transit router. financialLocked: The IPsec-VPN connection is locked due to overdue payments. provisioning: The IPsec-VPN connection is being prepared. updating: The IPsec-VPN connection is being updated. Upgrading: The IPsec-VPN connection is being upgraded. deleted: The IPsec-VPN connection is deleted.	attached
TransitRouterId	string	The ID of the transit router with which the IPsec-VPN connection is associated.	tr-p0we2edef9qr44a85****
TransitRouterName	string	The name of the transit router.	nametest
CrossAccountAuthorized	boolean	Indicates whether the IPsec-VPN connection is associated with a transit router that belongs to another Alibaba Cloud account. Valid values: true false	false
InternetIp	string	The gateway IP address of the IPsec-VPN connection. Note This parameter is returned only if the IPsec-VPN connection is associated with a transit router.	10.XX.XX.10
Tag	array<object>	The list of tags to be added to the IPsec-VPN connection.
Tag	object	The tags added to the IPsec-VPN connection.
Key	string	The tag key of the IPsec-VPN connection.	TagKey
Value	string	The tag value of the IPsec-VPN connection.	TagValue
TunnelOptionsSpecification	array<object>	The tunnel configuration of the IPsec-VPN connection. Parameters in TunnelOptionsSpecification are returned only if you query IPsec-VPN connections in dual-tunnel mode.
TunnelOptions	object	The tunnel configuration of the IPsec-VPN connection.
TunnelId	string	The tunnel ID.	tun-opsqc4d97wni27****
CustomerGatewayId	string	The ID of the customer gateway associated with the tunnel.	cgw-p0wy363lucf1uyae8****
EnableDpd	string	Indicates whether the DPD feature is enabled for the tunnel. Valid values: false true	true
EnableNatTraversal	string	Indicates whether NAT traversal is enabled for the tunnel. Valid values: false true	true
InternetIp	string	The tunnel IP address.	47.21.XX.XX
RemoteCaCertificate	string	The CA certificate of the tunnel peer. This parameter is returned only if the VPN gateway is of the SM type.	-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----
Role	string	The tunnel role. Valid values: master: The tunnel is an active tunnel. slave: The tunnel is a standby tunnel.	master
State	string	The tunnel status. Valid values: active updating deleting	active
Status	string	The state of the IPsec-VPN connection. Valid values: ike_sa_not_established: Phase 1 negotiations failed. ike_sa_established: Phase 1 negotiations succeeded. ipsec_sa_not_established: Phase 2 negotiations failed. ipsec_sa_established: Phase 2 negotiations succeeded.	ipsec_sa_established
TunnelBgpConfig	object	The BGP configurations.
BgpStatus	string	The negotiation state of BGP. Valid values: success false	success
LocalAsn	string	The ASN on the Alibaba Cloud side.	65530
LocalBgpIp	string	The BGP address on the Alibaba Cloud side.	169.254.10.1
PeerAsn	string	The ASN of the tunnel peer.	65531
PeerBgpIp	string	The BGP IP address of the tunnel peer.	169.254.10.2
TunnelCidr	string	The BGP CIDR block of the tunnel.	169.254.10.0/30
TunnelIkeConfig	object	The configuration of Phase 1 negotiations.
IkeAuthAlg	string	The authentication algorithm in the IKE phase.	sha1
IkeEncAlg	string	The encryption algorithm in the IKE phase.	aes
IkeLifetime	string	The lifetime in the IKE phase. Unit: seconds.	86400
IkeMode	string	The IKE negotiation mode. main: This mode offers higher security during negotiations. aggressive: This mode is faster and has a higher success rate.	main
IkePfs	string	The DH group in the IKE phase.	group2
IkeVersion	string	The version of the IKE protocol.	ikev1
LocalId	string	The identifier of the tunnel on the Alibaba Cloud side.	47.21.XX.XX
Psk	string	The pre-shared key.	123456****
RemoteId	string	The identifier of the tunnel peer.	47.42.XX.XX
TunnelIpsecConfig	object	The configurations of Phase 2 negotiations.
IpsecAuthAlg	string	The authentication algorithm in the IPsec phase.	sha1
IpsecEncAlg	string	The encryption algorithm in the IPsec phase.	aes
IpsecLifetime	string	The lifetime in the IPsec phase. Unit: seconds.	86400
IpsecPfs	string	The DH group in the IPsec phase.	group2
ZoneNo	string	The zone of the tunnel.	ap-southeast-5a
EnableTunnelsBgp	boolean	Indicates whether BGP is enabled for the tunnel. Valid values: true false	true
ResourceGroupId	string	The ID of the resource group to which the IPsec-VPN connection belongs. You can call the ListResourceGroups operation to query the resource group information.	rg-acfmzs372yg****

Examples

Sample success responses

JSONformat

{
  "PageSize": 10,
  "RequestId": "238752DC-0693-49BE-9C85-711D5691D3E5",
  "PageNumber": 1,
  "TotalCount": 2,
  "VpnConnections": {
    "VpnConnection": [
      {
        "Status": "ipsec_sa_established",
        "EnableNatTraversal": true,
        "RemoteCaCertificate": "-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----",
        "CreateTime": 1492753817000,
        "EffectImmediately": true,
        "VpnGatewayId": "vpn-bp1q8bgx4xnkm****",
        "LocalSubnet": "192.168.0.0/16,172.17.0.0/16",
        "VpnConnectionId": "vco-bp10lz7aejumd****",
        "RemoteSubnet": "10.0.0.0/8,172.16.0.0/16",
        "CustomerGatewayId": "cgw-bp1mvj4g9kogw****",
        "Name": "nametest",
        "EnableDpd": true,
        "IkeConfig": {
          "RemoteId": "139.17.XX.XX",
          "IkeLifetime": 86400,
          "IkeEncAlg": "aes",
          "LocalId": "116.64.XX.XX",
          "IkeMode": "main",
          "IkeVersion": "ikev1",
          "IkePfs": "group2",
          "Psk": "pgw6dy7****",
          "IkeAuthAlg": "sha1"
        },
        "IpsecConfig": {
          "IpsecAuthAlg": "sha1",
          "IpsecLifetime": 86400,
          "IpsecEncAlg": "aes",
          "IpsecPfs": "group2"
        },
        "VcoHealthCheck": {
          "Status": "success",
          "Dip": "192.168.0.1",
          "Interval": 2,
          "Retry": 3,
          "Sip": "192.168.0.50",
          "Enable": "true",
          "Policy": "revoke_route"
        },
        "VpnBgpConfig": {
          "Status": "success",
          "PeerBgpIp": "169.254.10.1",
          "TunnelCidr": "169.254.10.0/30",
          "LocalBgpIp": "169.254.10.2",
          "PeerAsn": 65530,
          "LocalAsn": 65531,
          "AuthKey": "AuthKey****"
        },
        "AttachType": "CEN",
        "NetworkType": "public",
        "AttachInstanceId": "cen-lxxpbpalc776qz****",
        "Spec": "1000M",
        "State": "attached",
        "TransitRouterId": "tr-p0we2edef9qr44a85****",
        "TransitRouterName": "nametest",
        "CrossAccountAuthorized": false,
        "InternetIp": "10.XX.XX.10",
        "Tag": {
          "Tag": [
            {
              "Key": "TagKey",
              "Value": "TagValue"
            }
          ]
        },
        "TunnelOptionsSpecification": {
          "TunnelOptions": [
            {
              "TunnelId": "tun-opsqc4d97wni27****",
              "CustomerGatewayId": "cgw-p0wy363lucf1uyae8****",
              "EnableDpd": "true",
              "EnableNatTraversal": "true",
              "InternetIp": "47.21.XX.XX",
              "RemoteCaCertificate": "-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----",
              "Role": "master",
              "State": "active",
              "Status": "ipsec_sa_established",
              "TunnelBgpConfig": {
                "BgpStatus": "success",
                "LocalAsn": "65530",
                "LocalBgpIp": "169.254.10.1",
                "PeerAsn": "65531",
                "PeerBgpIp": "169.254.10.2",
                "TunnelCidr": "169.254.10.0/30"
              },
              "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	Forbidden.TagKey.Duplicated	The specified tag key already exists.	The tag resources are duplicate.
400	SizeLimitExceeded.TagNum	The maximum number of tags is exceeded.	The number of tags has reached the upper limit.
400	InvalidParameter.TagValue	The specified parameter TagValue is invalid.	The error message returned because the specified tag value is invalid.
400	InvalidParameter.TagKey	The specified parameter TagKey is invalid.	The error message returned because the specified tag key is invalid.
400	Duplicated.TagKey	The specified parameter TagKey is duplicated.	The error message returned because the specified tag key already exists.
403	Forbbiden.SubUser	User not authorized to operate on the specified resource as your account is created by another user.	You are unauthorized to perform this operation on the specified resource. Acquire the required permissions and try again.
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.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-10-24	The Error code has changed. The response structure of the API has changed	View Change Details
2023-10-19	The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2023-08-01	API Description Update. The Error code has changed. The response structure of the API has changed	View Change Details
2023-06-30	The Error code has changed. The response structure of the API has changed	View Change Details
2023-06-13	The Error code has changed. The response structure of the API has changed	View Change Details
2023-05-04	The Error code has changed	View Change Details