All Products
Search
Document Center

Virtual Private Cloud:DescribeVpnGatewayAvailableZones

Last Updated:Mar 21, 2025

Queries zones that support IPsec-VPN connections 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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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:DescribeVpnGatewayAvailableZoneslist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
SpecstringYes

The bandwidth specification.

  • If an IPsec-VPN connection can be associated with the VPN gateway, this parameter specifies the bandwidth specification of the VPN gateway.
  • In scenarios where an IPsec-VPN connection can be associated with a transit router. This parameter specifies the bandwidth specification supported by an IPsec-VPN connection.

Different bandwidth specifications may affect returned zone information. Valid values:

  • 5M
  • 10M
  • 20M
  • 50M
  • 100M
  • 200M
  • 500M
  • 1000M
5M
AcceptLanguagestringNo

The language in which the returned results are displayed. Valid values:

  • zh-CN: Chinese
  • en-US (default): English
zh-CN

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RegionIdstring

The region ID.

cn-hangzhou
RequestIdstring

The request ID.

29784052-931F-543D-A612-36B3838163FA
AvailableZoneIdListarray<object>

The zones.

AvailableZoneIdobject
ZoneIdstring

The zone ID.

cn-hangzhou-h
ZoneNamestring

The zone name.

cn-hangzhou-h

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
403Forbbiden.SubUserUser 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.
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.