All Products
Search
Document Center

Virtual Private Cloud:DescribeVpnGateways

Last Updated:Nov 13, 2024

Queries VPN gateways in a region.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
vpc:DescribeVpnGatewayslist
  • VpnGateway
    acs:vpc:{#regionId}:{#accountId}:vpngateway/*
  • VpnGateway
    acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnInstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the VPN gateway.

You can call the DescribeRegions operation to query the most recent region list.

cn-zhangjiakou
VpcIdstringNo

The ID of the virtual private cloud (VPC) to which the VPN gateway belongs.

vpc-bp1m3i0kn1nd4wiw9****
VpnGatewayIdstringNo

The ID of the VPN gateway.

vpn-bp17lofy9fd0dnvzv****
StatusstringNo

The status of the VPN gateway. Valid values:

  • init
  • provisioning
  • active
  • updating
  • deleting
active
BusinessStatusstringNo

The payment status of the VPN gateway. Valid values:

  • Normal
  • FinancialLocked
Normal
PageNumberintegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Valid values: 1 to 50. Default value: 10.

10
IncludeReservationDatabooleanNo

Specifies whether to return information about pending orders. Valid values:

  • false (default)
  • true
true
Tagarray<object>No

The tags that are added to the VPN gateway.

objectNo

The tag added to the VPN gateway.

KeystringNo

The tag key.

You can specify at most 20 tag keys at a time.

FinanceDept
ValuestringNo

The tag value.

Each tag key corresponds to one tag value. You can specify at most 20 tag values at a time.

FinanceJoshua
ResourceGroupIdstringNo

The ID of the resource group to which the VPN gateway belongs.

You can call the ListResourceGroups operation to query the resource group list.

rg-acfmzs372yg****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

PageSizeinteger

The number of entries returned per page.

10
RequestIdstring

The request ID.

DF11D6F6-E35A-41C3-9B20-6FC8A901FE65
PageNumberinteger

The number of the returned page.

1
TotalCountinteger

The number of entries returned.

1
VpnGatewaysarray<object>

The information about the VPN gateways.

VpnGatewayobject

The information about the VPN gateway.

VpnTypestring

The type of VPN gateway.

Only Normal may be returned, which indicates a standard VPN gateway.

Normal
Statusstring

The status of the VPN gateway. Valid values:

  • init
  • provisioning
  • active
  • updating
  • deleting
active
VpcIdstring

The ID of the VPC to which the VPN gateway belongs.

vpc-bp1m3i0kn1nd4wiw9****
SslMaxConnectionslong

The number of SSL-VPN connections supported by the VPN gateway.

5
Specstring

The maximum bandwidth of the VPN gateway. Unit: M, which indicates Mbit/s.

5M
InternetIpstring
  • If the VPN gateway supports IPsec-VPN connections in single-tunnel mode, the value of this parameter is the IP address of the VPN gateway, which can be used to create IPsec-VPN or SSL-VPN connections.

  • If the VPN gateway supports IPsec-VPN connections in dual-tunnel mode, the value of this parameter is the first IP address that is used to create an IPsec-VPN connection. The IP address cannot be used to create SSL-VPN connections.

    If the VPN gateway supports IPsec-VPN connections in dual-tunnel mode, the system assigns two IPsec addresses to the VPN gateway to create IPsec-VPN connections in dual-tunnel mode.

47.12.XX.XX
CreateTimelong

The timestamp generated when the VPN gateway was created. Unit: milliseconds.

This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1515383700000
AutoPropagateboolean

Indicates whether BGP routes are automatically advertised to the VPC.

  • true
  • false
true
ChargeTypestring

The billing method of the VPN gateway.

Only POSTPAY may be returned, which indicates the pay-as-you-go billing method.

Example value for the China site (aliyun.com): Prepay. Example value for the International site (alibabacloud.com): POSTPAY.
VpnGatewayIdstring

The ID of the VPN gateway.

vpn-bp17lofy9fd0dnvzv****
Tagstring

The tag that is automatically generated for the VPN gateway.

  • VpnEnableBgp: indicates whether the VPN gateway supports BGP. Valid values:

    • true
    • false
  • VisuallySsl: indicates whether the VPN gateway allows you to view the connection information of SSL clients. Valid values:

    • true
    • false
  • PbrPriority: indicates whether the VPN gateway allows you to configure priorities for policy-based routes. Valid values:

    • true
    • false
  • VpnNewImage: indicates whether the VPN gateway is upgraded. Valid values:

    • true: queries only SQL templates that need to be optimized.
    • false: does not query only SQL statements that need to be optimized.
  • description: the description of the VPN gateway. This parameter is only for internal use.

  • VpnVersion: the version of the VPN gateway.

  • IDaaSNewVersion: indicates whether the VPN gateway can be associated with an EIAM 2.0 instance.

    • true
    • false
{\"VpnEnableBgp\":\"true\",\"VisuallySsl\":\"true\",\"PbrPriority\":\"true\",\"VpnNewImage\":\"true\",\"description\":\"forwarding1.3.7\",\"VpnVersion\":\"v1.2.4\"}
IpsecVpnstring

Indicates whether IPsec-VPN is enabled for the VPN gateway. Valid values:

  • enable
  • disable
enable
EndTimelong

The timestamp generated when the VPN gateway expires. Unit: milliseconds.

This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1518105600000
VSwitchIdstring

The ID of the vSwitch to which the VPN gateway belongs.

vsw-bp15lbk8sgtr6r5b0****
Descriptionstring

The description of the VPN gateway.

test
EnableBgpboolean

The BGP status of the VPN gateway. Valid values:

  • true
  • false
true
BusinessStatusstring

The payment status of the VPN gateway.

  • Normal
  • FinancialLocked
Normal
SslVpnstring

Indicates whether SSL-VPN is enabled for the VPN gateway. Valid values:

  • enable
  • disable
enable
Namestring

The name of the VPN gateway.

test
NetworkTypestring

The network type of the VPN gateway.

  • public
  • private
public
Tagsarray<object>

The tags that are added to the VPN gateway.

Tagobject
Keystring

The tag key.

FinanceDept
Valuestring

The tag value.

FinanceJoshua
ReservationDataobject

The information about pending orders.

Note This parameter is returned only if IncludeReservationData is set to true.
Statusstring

The status of the pending order.

  • 1: indicates that the order for renewal or the order for renewal with a specification change has not taken effect.
  • 2: indicates that the order of the temporary upgrade has taken effect. After the temporary upgrade expires, the system restores the VPN gateway to its previous specifications. In this case, the values of ReservationIpsec, ReservationMaxConnections, ReservationSpec, and ReservationSsl indicate the previous specifications of the VPN gateway.
1
ReservationOrderTypestring

The type of the order that has not taken effect. Valid values:

  • RENEWCHANGE: renewal with upgrade or downgrade
  • TEMP_UPGRADE: temporary upgrade
  • RENEW: renewal
TEMP_UPGRADE
ReservationIpsecstring

The IPsec-VPN status of the pending order. Valid values:

  • enable
  • disable
enable
ReservationSpecstring

The bandwidth of the pending order. Unit: Mbit/s.

5
ReservationSslstring

The SSL-VPN status of the pending order. Valid values:

  • enable
  • disable
enable
ReservationMaxConnectionsinteger

The maximum number of concurrent SSL-VPN connections of the pending order.

5
ReservationEndTimestring

If the value of ReservationOrderType is TEMP_UPGRADE, this parameter indicates the time when the temporary upgrade expires.

If the value of ReservationOrderType is RENEWCHANGE or RENEW, this parameter indicates the time when the renewal or renewal with a specification change takes effect.

2021-07-20T16:00:00Z
DisasterRecoveryInternetIpstring

The second IP address that is assigned to the VPN gateway to create IPsec-VPN connections.

This parameter is returned only if the VPN gateway supports IPsec-VPN connections in dual-tunnel mode.

47.91.XX.XX
DisasterRecoveryVSwitchIdstring

The ID of the second vSwitch that is associated with the VPN gateway.

This parameter is returned only if the VPN gateway supports IPsec-VPN connections in dual-tunnel mode.

vsw-p0w95ql6tmr2ludkt****
SslVpnInternetIpstring

The IP address of the SSL-VPN connection.

This parameter is returned only if the VPN gateway is a public VPN gateway and supports IPsec-VPN connections in dual-tunnel mode. In addition, SSL-VPN must be enabled for the VPN gateway.

47.74.XX.XX
ResourceGroupIdstring

The ID of the resource group to which the VPN gateway belongs.

You can call the ListResourceGroups operation to query resource groups.

rg-acfmzs372yg****
EniInstanceIdsarray

The ENIs created by the system for the VPN gateway.

EniInstanceIdstring

The ENI ID.

This parameter is returned only if the VPN gateway supports IPsec-VPN connections in dual-tunnel mode.

eni-7xvcxgmd4y2ypibn****

Examples

Sample success responses

JSONformat

{
  "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": "Example value for the China site (aliyun.com): Prepay. Example value for the International site (alibabacloud.com): POSTPAY.",
        "VpnGatewayId": "vpn-bp17lofy9fd0dnvzv****",
        "Tag": "{\\\"VpnEnableBgp\\\":\\\"true\\\",\\\"VisuallySsl\\\":\\\"true\\\",\\\"PbrPriority\\\":\\\"true\\\",\\\"VpnNewImage\\\":\\\"true\\\",\\\"description\\\":\\\"forwarding1.3.7\\\",\\\"VpnVersion\\\":\\\"v1.2.4\\\"}",
        "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****"
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameter.TagKeyThe specified parameter TagKey is invalid.The error message returned because the specified tag key is invalid.
400InvalidParameter.TagValueThe specified parameter TagValue is invalid.The error message returned because the specified tag value is invalid.
400Duplicated.TagKeyThe specified parameter TagKey is duplicated.The error message returned because the specified tag key already exists.
400InternalErrorThe request processing has failed due to some unknown error, exception or failure.An internal error occurred.
403Forbidden.SubUserUser 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.
403ForbiddenUser 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 timeSummary of changesOperation
2024-05-06The Error code has changed. The response structure of the API has changedView Change Details
2023-10-19API Description Update. The API operation is not deprecated.. The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedView Change Details
2023-06-30The Error code has changed. The response structure of the API has changedView Change Details
2023-05-04The Error code has changedView Change Details