Use DescribeVpnGateway to query VPN gateway details - VPN Gateway - Alibaba Cloud - VPN Gateway

Calls the DescribeVpnGateway API to query the details of a specified VPN gateway.

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:DescribeVpnGateway

get

*VpnGateway

acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnGatewayId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the VPN gateway. You can call the DescribeRegions API to obtain the region ID.	cn-hangzhou
VpnGatewayId	string	Yes	The ID of the VPN gateway instance.	vpn-bp1r3v1xqkl0w519g****
IncludeReservationData	boolean	No	Specifies whether to include pending order data. Valid values: false (default): Does not include pending order data. true: Includes pending order data.	true

Response elements

Element	Type	Description	Example
	object	The response parameters.
VpnType	string	The type of the VPN gateway. Value: Normal, indicating a standard type.	Normal
Status	string	The status of the VPN gateway. Valid values: init: Initializing. provisioning: Preparing. active: Normal. updating: Updating. deleting: Deleting.	init
VpcId	string	The ID of the VPC to which the VPN gateway belongs.	vpc-bp19m2yx1m5q0avyq****
SslMaxConnections	integer	The maximum number of concurrent SSL-VPN connections.	5
Spec	string	The bandwidth specification of the VPN gateway. Unit: Mbps.	5
InternetIp	string	In scenarios where the VPN gateway instance supports creating single-tunnel mode IPsec-VPN connections, this address is the IP address of the VPN gateway instance and can be used to create IPsec-VPN connections or SSL-VPN connections. In scenarios where the VPN gateway instance supports creating dual-tunnel mode IPsec-VPN connections, this address is the first IP address used to create IPsec-VPN connections and cannot be used to create SSL-VPN connections. In scenarios where the VPN gateway instance supports creating dual-tunnel mode IPsec-VPN connections, the system assigns two IPsec addresses to the VPN gateway instance for creating dual-tunnel mode IPsec-VPN connections.	47.22.XX.XX
CreateTime	integer	The timestamp when the VPN gateway was created. Unit: milliseconds. The timestamp is in Unix format, representing the total number of milliseconds elapsed from January 1, 1970, 00:00:00 UTC to the creation time of the VPN gateway.	1495382400000
AutoPropagate	boolean	Indicates whether the automatic route propagation feature is enabled for the VPN gateway. Valid values: true: Enabled. false: Disabled.	true
ChargeType	string	The billing method. Valid values: POSTPAY: Pay-as-you-go.	中国站示例值：Prepay，国际站示例值：POSTPAY
VpnGatewayId	string	The ID of the VPN gateway instance.	vpn-bp1r3v1xqkl0w519g****
Tag	string	The system-generated tags of the VPN gateway. VpnEnableBgp: Indicates whether the VPN gateway supports the BGP feature. true: Supported. false: Not supported. VisuallySsl: Indicates whether the VPN gateway supports viewing SSL client connection information. true: Supported. false: Not supported. PbrPriority: Indicates whether the VPN gateway supports configuring policy priorities for policy-based routes. true: Supported. false: Not supported. VpnNewImage: Indicates whether the VPN gateway is a new-generation VPN gateway. true: Yes. false: No. description: The description of the VPN gateway, used for internal system purposes only. VpnVersion: The version number of the VPN gateway. IDaaSNewVersion: Indicates whether the VPN gateway supports binding to EIAM 2.0 instances. true: Supported. false: Not supported.	{\"VpnEnableBgp\":\"true\",\"VisuallySsl\":\"true\",\"PbrPriority\":\"true\",\"VpnNewImage\":\"true\",\"description\":\"转发1.3.24\",\"VpnVersion\":\"v1.2.4\",\"IDaaSNewVersion\":\"true\"}
IpsecVpn	string	Indicates whether the IPsec-VPN feature is enabled. Valid values: enable: Enabled. disable: Disabled.	enable
EndTime	integer	The expiration timestamp of the VPN gateway. Unit: milliseconds. The timestamp is in Unix format, representing the total number of milliseconds elapsed from January 1, 1970, 00:00:00 UTC to the expiration time of the VPN gateway.	1544666102000
VSwitchId	string	The ID of the vSwitch to which the VPN gateway belongs.	vsw-bp1dmzugdikc6hdgx****
RequestId	string	The request ID.	27E4E088-8DE0-4672-BF5C-0A412389DB9E
Description	string	The description of the VPN gateway.	vpngatewaydescription
EnableBgp	boolean	The BGP feature status of the VPN gateway. Valid values: true: Enabled. false: Disabled.	true
BusinessStatus	string	The billing status of the VPN gateway. Valid values: Normal: Normal. FinancialLocked: Locked due to overdue payment.	Normal
SslVpn	string	The status of the SSL-VPN feature. Valid values: enable: Enabled. disable: Disabled.	enable
Name	string	The name of the VPN gateway.	vpngatewayname
ReservationData	object	The pending order data. Note This parameter is returned only when IncludeReservationData is set to true.
Status	string	The status of the pending order. Valid values: 1: Indicates that the renewal or renewal with specification change order has not taken effect. 2: Indicates that the temporary upgrade order has taken effect. After the restoration time is reached, the system will restore the VPN gateway specification to the specification before the temporary upgrade. In this case, ReservationIpsec, ReservationMaxConnections, ReservationSpec, and ReservationSsl represent the specifications before the temporary upgrade of the VPN gateway.	1
ReservationOrderType	string	The type of the pending order. Valid values: RENEWCHANGE: Renewal with specification change. TEMP_UPGRADE: Temporary upgrade. RENEW: Renewal.	TEMP_UPGRADE
ReservationIpsec	string	The IPsec-VPN feature status of the pending order. Valid values: enable: Enabled. disable: Disabled.	enable
ReservationSpec	string	The bandwidth specification of the pending order. Unit: Mbps.	5
ReservationSsl	string	The SSL-VPN feature status of the pending order. Valid values: enable: Enabled. disable: Disabled.	enable
ReservationMaxConnections	integer	The maximum number of concurrent SSL-VPN connections for the pending order.	5
ReservationEndTime	string	If the pending order type is TEMP_UPGRADE (temporary upgrade), this parameter indicates the restoration time for the temporary upgrade. If the pending order type is RENEWCHANGE (renewal with specification change) or RENEW (renewal), this parameter indicates the time when the renewal or renewal with specification change takes effect.	2020-07-20T16:00:00Z
Tags	object
Tag	array<object>	The list of tags bound to the VPN gateway instance.
	object	The list of tags bound to the VPN gateway instance.
Key	string	Tag key.	aaa
Value	string	The tag value.	bbb
NetworkType	string	The network type of the VPN gateway. public: Public VPN gateway. private: Private VPN gateway.	public
DisasterRecoveryInternetIp	string	The second IP address assigned by the system to the VPN gateway instance for creating IPsec-VPN connections. This parameter is returned only for VPN gateway instances that support creating dual-tunnel mode IPsec-VPN connections.	47.91.XX.XX
DisasterRecoveryVSwitchId	string	The ID of the second vSwitch associated with the VPN gateway instance. This parameter is returned only for VPN gateway instances that support creating dual-tunnel mode IPsec-VPN connections.	vsw-p0w95ql6tmr2ludkt****
SslVpnInternetIp	string	The IP address for SSL-VPN connections. This parameter is returned only when SSL-VPN is enabled on a public-network VPN gateway instance that supports creating dual-tunnel mode IPsec-VPN connections.	47.74.XX.XX
ResourceGroupId	string	The ID of the resource group to which the VPN gateway belongs. You can call the ListResourceGroups API to query resource group information.	rg-acfmzs372yg****
EniInstanceIds	object
EniInstanceId	array	The list of Elastic Network Interfaces (ENIs) created by the system for the VPN gateway instance.
	string	The ENI ID. This parameter is returned only for VPN gateway instances that support creating dual-tunnel mode IPsec-VPN connections.	eni-7xvcxgmd4y2ypibn****
GatewayType	string	The VPN gateway type. Valid values: Traditional: Traditional VPN gateway, covering both IPsec and SSL features. Enhanced.SiteToSite: Enhanced site-to-cloud VPN, covering only IPsec features.	Enhanced.SiteToSite

Examples

Success response

JSON format

{
  "VpnType": "Normal",
  "Status": "init",
  "VpcId": "vpc-bp19m2yx1m5q0avyq****",
  "SslMaxConnections": 5,
  "Spec": "5",
  "InternetIp": "47.22.XX.XX",
  "CreateTime": 1495382400000,
  "AutoPropagate": true,
  "ChargeType": "中国站示例值：Prepay，国际站示例值：POSTPAY",
  "VpnGatewayId": "vpn-bp1r3v1xqkl0w519g****",
  "Tag": "{\\\"VpnEnableBgp\\\":\\\"true\\\",\\\"VisuallySsl\\\":\\\"true\\\",\\\"PbrPriority\\\":\\\"true\\\",\\\"VpnNewImage\\\":\\\"true\\\",\\\"description\\\":\\\"转发1.3.24\\\",\\\"VpnVersion\\\":\\\"v1.2.4\\\",\\\"IDaaSNewVersion\\\":\\\"true\\\"}",
  "IpsecVpn": "enable",
  "EndTime": 1544666102000,
  "VSwitchId": "vsw-bp1dmzugdikc6hdgx****",
  "RequestId": "27E4E088-8DE0-4672-BF5C-0A412389DB9E",
  "Description": "vpngatewaydescription",
  "EnableBgp": true,
  "BusinessStatus": "Normal",
  "SslVpn": "enable",
  "Name": "vpngatewayname",
  "ReservationData": {
    "Status": "1",
    "ReservationOrderType": "TEMP_UPGRADE",
    "ReservationIpsec": "enable",
    "ReservationSpec": "5",
    "ReservationSsl": "enable",
    "ReservationMaxConnections": 5,
    "ReservationEndTime": "2020-07-20T16:00:00Z"
  },
  "Tags": {
    "Tag": [
      {
        "Key": "aaa",
        "Value": "bbb"
      }
    ]
  },
  "NetworkType": "public",
  "DisasterRecoveryInternetIp": "47.91.XX.XX",
  "DisasterRecoveryVSwitchId": "vsw-p0w95ql6tmr2ludkt****",
  "SslVpnInternetIp": "47.74.XX.XX",
  "ResourceGroupId": "rg-acfmzs372yg****",
  "EniInstanceIds": {
    "EniInstanceId": [
      "eni-7xvcxgmd4y2ypibn****"
    ]
  },
  "GatewayType": "Enhanced.SiteToSite"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidVpnGatewayInstanceId.NotFound	The specified vpn gateway instance id does not exist.	The specified VPN gateway does not exist. Check whether the specified VPN gateway is valid.
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	InvalidVpnGatewayInstanceId.NotFound	The specified vpn gateway instance id does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.