DescribeZones

Last updated: 2021-11-16 17:22:20

1. API Description

Domain name for API request: postgres.tencentcloudapi.com.

This API is used to query the supported AZs.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeZones.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of returned results.
ZoneSet Array of ZoneInfo AZ information set.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying AZs in a specified region

Input Example

https://postgres.tencentcloudapi.com/?Action=DescribeZones
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "59c438d4-95ab-4865-993d-dc388d2660d8",
    "TotalCount": 3,
    "ZoneSet": [
      {
        "Zone": "ap-guangzhou-2",
        "ZoneName": "Guangzhou Zone 2",
        "ZoneId": 100002,
        "ZoneState": "AVAILABLE",
        "ZoneSupportIpv6": 0
      },
      {
        "Zone": "ap-guangzhou-3",
        "ZoneName": "Guangzhou Zone 3",
        "ZoneId": 100003,
        "ZoneState": "AVAILABLE",
        "ZoneSupportIpv6": 0
      },
      {
        "Zone": "ap-guangzhou-4",
        "ZoneName": "Guangzhou Zone 4",
        "ZoneId": 100004,
        "ZoneState": "AVAILABLE",
        "ZoneSupportIpv6": 0
      }
    ]
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
AuthFailure.UnauthorizedOperation Authentication failed.
FailedOperation.CamSigAndAuthError Authentication failed. Please try again later. If the problem persists, please contact customer service.
FailedOperation.DatabaseAccessError Failed to access database management service. Please try again later. If the problem persists, please contact customer service.
FailedOperation.FailedOperationError Operation failed. Please try again later.
InternalError.DBError Backend database execution error.
InternalError.SystemError System error. When this error occurs, please contact customer service for assistance.
InternalError.UnknownError Unknown error. When this error occurs, please contact customer service for assistance.
InvalidParameter Parameter error.
InvalidParameterValue.InvalidParameterValueError Incorrect parameter value
InvalidParameterValue.ParameterHandleError Failed to process the parameter. Please check if the parameter value is valid.
InvalidParameterValue.RegionNotSupported The current region is not supported.
InvalidParameterValue.StructParseFailed An error occurred while parsing parameters.
OperationDenied.CamDeniedError This operation cannot be performed.
ResourceNotFound.InstanceNotFoundError The instance does not exist.