Use DescribeVpnGatewayAvailableZones to query available zones for IPsec-VPN - VPN Gateway - Alibaba Cloud - 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:DescribeVpnGatewayAvailableZones

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
Spec	string	Yes	The bandwidth specification. If the IPsec-VPN connection is associated with a VPN gateway instance, this parameter specifies the bandwidth specification of the VPN gateway instance. If the IPsec-VPN connection is associated with a transit router, this parameter specifies the expected bandwidth specification that the IPsec-VPN connection can support. Different bandwidth specifications may affect the returned zone information. Valid values: 5M 10M 20M 50M 100M 200M 500M 1000M.	5M
AcceptLanguage	string	No	The language in which the returned results are displayed. Valid values: zh-CN: Chinese. en-US (default): English.	zh-CN
GatewayType	string	No	The VPN gateway type. Valid values: Traditional: returns zone information for creating traditional VPN gateways. Enhanced.SiteToSite: returns zone information for creating enhanced site-to-cloud VPN gateways. Default value: returns zone information for creating all types of VPN gateways.	Traditional

Response elements

Element	Type	Description	Example
	object	The response parameters.
RegionId	string	The region ID.	cn-hangzhou
RequestId	string	The request ID.	29784052-931F-543D-A612-36B3838163FA
AvailableZoneIdList	array<object>	The list of zones.
	object	The zone information.
ZoneId	string	The zone ID.	cn-hangzhou-h
ZoneName	string	The zone name.	cn-hangzhou-h

Examples

Success response

JSON format

{
  "RegionId": "cn-hangzhou",
  "RequestId": "29784052-931F-543D-A612-36B3838163FA",
  "AvailableZoneIdList": [
    {
      "ZoneId": "cn-hangzhou-h",
      "ZoneName": "cn-hangzhou-h"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.