tencent cloud

All product documents
APIs
DocumentationAPIsTencentDB for PostgreSQLSpecification APIsDescribeProductConfig
DescribeProductConfig
Last updated: 2024-06-17 14:25:48
DescribeProductConfig
Last updated: 2024-06-17 14:25:48

1. API Description

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

This API is used to query the purchasable specification configuration. u200cThis API is disused and replaced by the DescribeClasses API.

A maximum of 1000 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: DescribeProductConfig.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
Zone No String AZ name
DBEngine No String Database engines. Valid values:
1. postgresql (TencentDB for PostgreSQL)
2. mssql_compatible (MSSQL compatible-TencentDB for PostgreSQL)
Default value: postgresql

3. Output Parameters

Parameter Name Type Description
SpecInfoList Array of SpecInfo Purchasable specification list.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying purchasable specifications in an AZ in a region

This example shows you how to query the purchasable specifications in Guangzhou Zone 2.

Input Example

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

{
    "Zone": "ap-guangzhou-2"
}

Output Example

{
    "Response": {
        "RequestId": "eaa0a364-08c9-42f6-888e-4e3b7e99b50d",
        "SpecInfoList": [
            {
                "Region": "ap-guangzhou",
                "Zone": "ap-guangzhou-2",
                "SupportKMSRegions": [
                    "ap-guangzhou"
                ],
                "SpecItemInfoList": [
                    {
                        "SpecCode": "cdb.pg.z1.2g",
                        "Version": "10.4",
                        "VersionName": "PostgreSQL 10",
                        "Cpu": 1,
                        "Memory": 2048,
                        "MaxStorage": 1000,
                        "MinStorage": 10,
                        "Qps": 2100,
                        "Pid": 11004,
                        "Type": "TS85",
                        "KernelVersion": "v10.4_r1.0",
                        "MajorVersion": "10",
                        "IsSupportTDE": 1
                    }
                ]
            }
        ]
    }
}

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.
FailedOperation.WhitelistConnectError Failed to query the allowlist. Try again later. If the problem persists, contact customer service.
InternalError.DBError Backend database execution error.
InternalError.InternalHttpServerError An exception occurred while executing the request.
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.
InvalidParameter.ParameterCheckError Failed to check the parameter.
InvalidParameterValue.BadSpec The instance specification to upgrade to is not purchasable.
InvalidParameterValue.IllegalZone Invalid Zone parameter.
InvalidParameterValue.InvalidParameterValueError Incorrect parameter value
InvalidParameterValue.ParameterHandleError Failed to process the parameter. Please check if the parameter value is valid.
OperationDenied.CamDeniedError This operation cannot be performed.
ResourceNotFound.InstanceNotFoundError The instance does not exist.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

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

Contact Us
Technical Support

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

Submit a Ticket
7x24 Phone Support