tencent cloud

Feedback

DescribeRegions

Last updated: 2022-07-08 10:22:46

    1. API Description

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

    This API is used to query the purchasable regions.

    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 Params. The value used for this API: DescribeRegions.
    Version Yes String Common Params. The value used for this API: 2017-03-12.
    Region Yes String Common Params. 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.
    RegionSet Array of RegionInfo Region 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 all regions

    Input Example

    POST / HTTP/1.1
    Host: postgres.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeRegions
    <Common request parameters>
    {}
    

    Output Example

    {
    "Response": {
      "RequestId": "0872c9bb-0540-4ac4-80cf-ba63bd771b0a",
      "TotalCount": 7,
      "RegionSet": [
        {
          "Region": "ap-guangzhou",
          "RegionName": "South China (Guangzhou)",
          "RegionId": 1,
          "SupportInternational": 0,
          "RegionState": "AVAILABLE"
        },
        {
          "Region": "ap-chengdu",
          "RegionName": "Southwest China (Chengdu)",
          "RegionId": 16,
          "SupportInternational": 0,
          "RegionState": "AVAILABLE"
        },
        {
          "Region": "ap-shanghai",
          "RegionName": "East China (Shanghai)",
          "RegionId": 4,
          "SupportInternational": 0,
          "RegionState": "AVAILABLE"
        },
        {
          "Region": "na-toronto",
          "RegionName": "North America (Toronto)",
          "RegionId": 6,
          "SupportInternational": 1,
          "RegionState": "UNAVAILABLE"
        },
        {
          "Region": "ap-beijing",
          "RegionName": "North China (Beijing)",
          "RegionId": 8,
          "SupportInternational": 0,
          "RegionState": "AVAILABLE"
        },
        {
          "Region": "na-siliconvalley",
          "RegionName": "West US (Silicon Valley)",
          "RegionId": 15,
          "SupportInternational": 1,
          "RegionState": "AVAILABLE"
        }
      ]
    }
    }
    

    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 Internal error.
    InternalError.DBError Backend database execution error.
    InternalError.InternalHttpServerError An exception occurred while executing the request.
    InvalidParameter Parameter error.
    InvalidParameterValue.InterfaceNameNotFound Incorrect ACTION.
    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.
    UnsupportedOperation The operation is not supported.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support