tencent cloud

All product documents
TencentDB for PostgreSQL
DocumentationTencentDB for PostgreSQLAPI DocumentationBackup and Recovery APIsDescribeCloneDBInstanceSpec
DescribeCloneDBInstanceSpec
Download PDF
Last updated: 2024-06-17 14:26:34
DescribeCloneDBInstanceSpec
Last updated: 2024-06-17 14:26:34
Download PDF

1. API Description

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

This API is used to query the minimum specification required by a cloned instance, including SpecCode and disk specification.

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: DescribeCloneDBInstanceSpec.
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.
DBInstanceId Yes String Instance ID.
BackupSetId No String Basic backup set ID. Either this parameter or RecoveryTargetTime must be passed in. If both are passed in, only this parameter takes effect.
RecoveryTargetTime No String Restoration time (UTC+8). Either this parameter or BackupSetId must be passed in.

3. Output Parameters

Parameter Name Type Description
MinSpecCode String Code of the minimum specification available for purchase.
MinStorage Integer The minimum disk capacity in GB available for purchase.
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 the minimum specification for cloning the instance "postgres-apzvwncr"

u200cu200cu200cu200cu200cThis example shows you how to query the minimum specification for cloning the instance “postgres-apzvwncr”.

Input Example

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

{
    "RecoveryTargetTime": "2021-12-24 03:41:50",
    "DBInstanceId": "postgres-apzvwncr"
}

Output Example

{
    "Response": {
        "RequestId": "08fdf411-5d39-44f2-8e1d-a58ee60b237d",
        "MinSpecCode": "cdb.pg.sh1.2g",
        "MinStorage": 10
    }
}

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
FailedOperation.CamCheckResourceError Failed to get permissions. Please try again later. If the problem persists, please contact customer service.
FailedOperation.FailedOperationError Operation failed. Please try again later.
FailedOperation.QuerySpecError Failed to query specifications. Please try again later. If the problem persists, please contact customer service.
InternalError.InternalHttpServerError An exception occurred while executing the request.
InvalidParameterValue.InvalidParameterValueError Incorrect parameter value
OperationDenied.CamDeniedError This operation cannot be performed.
OperationDenied.InstanceAccessDeniedError You do not have the permission to operate this resource.
OperationDenied.InstanceStatusLimitOpError This operation cannot be performed on an instance in this status.
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
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon