DescribeVpnGateways API Reference - VPN Gateway - Alibaba Cloud - VPN Gateway

Queries VPN gateways that are created in a specified region.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the VPN gateway. You can call the DescribeRegions operation to query the region ID.	cn-hangzhou
VpcId	string	No	The ID of the virtual private cloud (VPC) to which the VPN gateway belongs.	vpc-bp1m3i0kn1nd4wiw9****
VpnGatewayId	string	No	The ID of the VPN gateway.	vpn-bp17lofy9fd0dnvzv****
Status	string	No	The status of the VPN gateway. Valid values: init: initializing. provisioning: preparing. active: Normal. updating: updating. deleting: deleting.	active
BusinessStatus	string	No	The billing status of the VPN gateway. Valid values: Normal: Normal. FinancialLocked: locked due to overdue payment.	Normal
PageNumber	integer	No	The page number of the list. Default value: 1.	1
PageSize	integer	No	The number of entries per page in a paged query. Valid values: 1 to 50. Default value: 10.	10
IncludeReservationData	boolean	No	Specifies whether to include pending subscription data. Valid values: false (default): does not include pending subscription data. true: includes pending subscription data.	true
Tag	array<object>	No	The list of tags bound to the VPN gateway.
	object	No	The tag bound to the VPN gateway.
Key	string	No	The tag key. You can specify up to 20 tag keys at a time.	FinanceDept
Value	string	No	The tag value. Each tag key corresponds to one tag value. You can specify up to 20 tag values at a time.	FinanceJoshua
ResourceGroupId	string	No	The ID of the resource group to which the VPN gateway belongs. You can call the ListResourceGroups operation to query resource group IDs.	rg-acfmzs372yg****
GatewayType	string	No	The type of the VPN gateway. Valid values: Traditional: a traditional VPN gateway that supports both IPsec-VPN and SSL-VPN features. Enhance.SiteToSite: an enhanced site-to-cloud VPN gateway that supports only the IPsec-VPN feature.	Enhance.SiteToSite

Response elements

Element	Type	Description	Example
	object	The response parameters.
PageSize	integer	The number of entries per page in a paging query.	10
RequestId	string	The request ID.	DF11D6F6-E35A-41C3-9B20-6FC8A901FE65
PageNumber	integer	The page number of the list.	1
TotalCount	integer	The total number of entries.	1
VpnGateways	object
VpnGateway	array<object>	The list of VPN gateways.
	array<object>	The information about the VPN gateway.
VpnType	string	The Type of the VPN Gateway. Valid value: Normal, which indicates the standard type.	Normal
Status	string	The status of the VPN Gateway. init: Initialization. provisioning: Provisioning. active: Normal. updating: Updating. deleting: Deleting.	active
VpcId	string	The ID of the VPC to which the VPN Gateway belongs.	vpc-bp1m3i0kn1nd4wiw9****
SslMaxConnections	integer	The specification of the number of SSL-VPN connections for the VPN Gateway.	5
Spec	string	The peak bandwidth of the VPN Gateway. M indicates the unit Mbps.	5M
InternetIp	string	In the scenario where the VPN Gateway instance supports creating IPsec-VPN connections in single-tunnel mode, this address is the IP address of the VPN Gateway instance and can be used to create either an IPsec-VPN connection or an SSL-VPN connection. In the scenario where the VPN Gateway instance supports creating IPsec-VPN connections in dual-tunnel mode, this address is the first IP address used to create an IPsec-VPN connection and cannot be used to create an SSL-VPN connection. In the scenario where the VPN Gateway instance supports creating IPsec-VPN connections in dual-tunnel mode, the System assigns two IPsec addresses to the VPN Gateway instance for establishing dual-tunnel IPsec-VPN connections.	47.12.XX.XX
CreateTime	integer	The UNIX timestamp when the VPN Gateway was created. Unit: milliseconds. The timestamp follows the Unix format, which represents the total duration in milliseconds from 00:00:00 UTC on January 1, 1970, to the time when the VPN Gateway instance was created.	1515383700000
AutoPropagate	boolean	Indicates whether automatic BGP route propagation is enabled for the VPN Gateway. true: Enabled. false: Disabled.	true
ChargeType	string	The billing method of the VPN Gateway. Valid value: POSTPAY, pay-as-you-go billing method.	中国站示例值：Prepay，国际站示例值：POSTPAY
VpnGatewayId	string	The ID of the VPN Gateway.	vpn-bp17lofy9fd0dnvzv****
Tag	string	The system-generated tag of the VPN Gateway. VpnEnableBgp: Indicates whether the VPN Gateway supports Border Gateway Protocol (BGP). true: Supported. false: Not supported. VisuallySsl: Indicates whether the VPN Gateway supports viewing Connection information of SSL clients. true: Supported. false: Not supported. PbrPriority: Indicates whether the VPN Gateway supports configuring policy priority for policy-based routing. true: Supported. false: Not supported. VpnNewImage: Indicates whether the VPN Gateway is a new-type VPN Gateway. true: Yes. false: No. description: The Description of the VPN Gateway, used internally by the System only. VpnVersion: The version number of the VPN Gateway. IDaaSNewVersion: Indicates whether the VPN Gateway supports attaching to an EIAM 2.0 instance. 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 on the VPN Gateway. enable: Enabled. disable: Disabled.	enable
EndTime	integer	The expiration time of the VPN Gateway, expressed as a UNIX timestamp in milliseconds. The timestamp follows the Unix format, representing the total number of milliseconds elapsed since 00:00:00 UTC on January 1, 1970, until the expiration time of the VPN Gateway instance.	1518105600000
VSwitchId	string	The ID of the vSwitch to which the VPN Gateway belongs.	vsw-bp15lbk8sgtr6r5b0****
Description	string	The Description of the VPN Gateway.	test
EnableBgp	boolean	The enabling status of the Border Gateway Protocol (BGP) feature for the VPN Gateway. true: Enabled. false: Disabled.	true
BusinessStatus	string	The billing status of the VPN Gateway. Normal: Normal. FinancialLocked: Financial lock due to overdue payment.	Normal
SslVpn	string	Indicates whether the SSL-VPN feature is Enabled on the VPN Gateway. enable: Enabled. disable: Disabled.	enable
Name	string	The name of the VPN Gateway.	test
NetworkType	string	The network type of the VPN Gateway. public: public VPN gateway. private: private VPN gateway.	public
Tags	object
Tag	array<object>	The list of tags attached to the VPN Gateway.
	object	The tag information attached to the VPN Gateway.
Key	string	The tag key.	FinanceDept
Value	string	The tag value.	FinanceJoshua
ReservationData	object	The subscription data that has not taken effect. Note This group of parameters is returned only when IncludeReservationData is set to true.
Status	string	Status of an order that is not yet in effect. 1: Indicates that a renewal or renewal with specification change order is not yet in effect. 2: Indicates that a temporary upgrade order is already in effect. After the revert time is reached, the system reverts the VPN Gateway specifications to those before the temporary upgrade. At this point, ReservationIpsec, ReservationMaxConnections, ReservationSpec, and ReservationSsl reflect the specifications of the VPN Gateway before the temporary upgrade.	1
ReservationOrderType	string	Type of an order that is not yet in effect. RENEWCHANGE: Renewal with specification change. TEMP_UPGRADE: Temporary upgrade. RENEW: Renewal.	TEMP_UPGRADE
ReservationIpsec	string	The enabling status of the IPsec-VPN feature for the pending order. enable: Enabled. disable: Disabled.	enable
ReservationSpec	string	The bandwidth specification of the pending order. Unit: Mbps.	5
ReservationSsl	string	Enabling status of the SSL-VPN feature for an order that is not yet in effect. enable: Enabled. disable: Disabled.	enable
ReservationMaxConnections	integer	Specification of the number of concurrent SSL-VPN users for an order that is not yet in effect.	5
ReservationEndTime	string	If the order type that is not yet in effect is TEMP_UPGRADE (temporary upgrade), this parameter indicates the revert time for the temporary upgrade. If the order type that is not yet in effect is RENEWCHANGE (renewal with specification change) or RENEW (renewal), this parameter indicates the effective start time of the renewal or renewal with specification change.	2021-07-20T16:00:00Z
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 IPsec-VPN connections in dual-tunnel mode.	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 IPsec-VPN connections.	vsw-p0w95ql6tmr2ludkt****
SslVpnInternetIp	string	The IP address for SSL-VPN connections. This parameter is returned only after the SSL-VPN feature is enabled on a VPN Gateway instance that uses the Internet network type and supports dual-tunnel IPsec-VPN connections.	47.74.XX.XX
ResourceGroupId	string	The ID of the resource group to which the VPN Gateway belongs. You can invoke the ListResourceGroups API to query resource group information.	rg-acfmzs372yg****
EniInstanceIds	object
EniInstanceId	array	The list of Elastic Network Interfaces (ENIs) that the System creates for the VPN Gateway instance.
	string	The ENI ID. This parameter is returned only for VPN Gateway instances that support creating IPsec-VPN connections in dual-tunnel mode.	eni-7xvcxgmd4y2ypibn****
GatewayType	string	The type of the VPN Gateway. Valid values: Traditional: A traditional VPN Gateway that supports both IPsec and SSL features. Enhance.SiteToSite: An enhanced site-to-cloud VPN Gateway that supports only IPsec features.	Enhance.SiteToSite

Examples

Success response

JSON format

{
  "PageSize": 10,
  "RequestId": "DF11D6F6-E35A-41C3-9B20-6FC8A901FE65",
  "PageNumber": 1,
  "TotalCount": 1,
  "VpnGateways": {
    "VpnGateway": [
      {
        "VpnType": "Normal",
        "Status": "active",
        "VpcId": "vpc-bp1m3i0kn1nd4wiw9****",
        "SslMaxConnections": 5,
        "Spec": "5M",
        "InternetIp": "47.12.XX.XX",
        "CreateTime": 1515383700000,
        "AutoPropagate": true,
        "ChargeType": "中国站示例值：Prepay，国际站示例值：POSTPAY",
        "VpnGatewayId": "vpn-bp17lofy9fd0dnvzv****",
        "Tag": "{\\\"VpnEnableBgp\\\":\\\"true\\\",\\\"VisuallySsl\\\":\\\"true\\\",\\\"PbrPriority\\\":\\\"true\\\",\\\"VpnNewImage\\\":\\\"true\\\",\\\"description\\\":\\\"转发1.3.24\\\",\\\"VpnVersion\\\":\\\"v1.2.4\\\",\\\"IDaaSNewVersion\\\":\\\"true\\\"}",
        "IpsecVpn": "enable",
        "EndTime": 1518105600000,
        "VSwitchId": "vsw-bp15lbk8sgtr6r5b0****",
        "Description": "test",
        "EnableBgp": true,
        "BusinessStatus": "Normal",
        "SslVpn": "enable",
        "Name": "test",
        "NetworkType": "public",
        "Tags": {
          "Tag": [
            {
              "Key": "FinanceDept",
              "Value": "FinanceJoshua"
            }
          ]
        },
        "ReservationData": {
          "Status": "1",
          "ReservationOrderType": "TEMP_UPGRADE",
          "ReservationIpsec": "enable",
          "ReservationSpec": "5",
          "ReservationSsl": "enable",
          "ReservationMaxConnections": 5,
          "ReservationEndTime": "2021-07-20T16:00:00Z"
        },
        "DisasterRecoveryInternetIp": "47.91.XX.XX",
        "DisasterRecoveryVSwitchId": "vsw-p0w95ql6tmr2ludkt****",
        "SslVpnInternetIp": "47.74.XX.XX",
        "ResourceGroupId": "rg-acfmzs372yg****",
        "EniInstanceIds": {
          "EniInstanceId": [
            "eni-7xvcxgmd4y2ypibn****"
          ]
        },
        "GatewayType": "Enhance.SiteToSite"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.TagKey	The specified parameter TagKey is invalid.	The error message returned because the specified tag key is invalid.
400	InvalidParameter.TagValue	The specified parameter TagValue is invalid.	The error message returned because the specified tag value is invalid.
400	Duplicated.TagKey	The specified parameter TagKey is duplicated.	The error message returned because the specified tag key already exists.
400	InternalError	The request processing has failed due to some unknown error, exception or failure.
403	Forbidden.SubUser	User not authorized to operate on the specified resource as your account is created by another user.	The error message returned because 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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.