Release Notes
Product Announcements
Domain name for API request: postgres.intl.tencentcloudapi.com.
This API is used to clone an instance by specifying a backup set or a point in time.
A maximum of 100 requests can be initiated per second for this API.
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: CloneDBInstance. |
| 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. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo. |
| DBInstanceId | Yes | String | The source instance ID to be cloned. can be obtained through the DescribeDBInstances api (https://www.tencentcloud.comom/document/api/409/16773?from_cn_redirect=1). |
| SpecCode | Yes | String | Purchasable code, which can be obtained from the SpecCode field in the return value of the DescribeClasses API. |
| Storage | Yes | Integer | Instance disk capacity size. set step size to 10. unit: GB. |
| Period | Yes | Integer | Purchase duration, in months. - Prepaid: Supports 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, and 36.- Pay-as-you-go: Only supports 1. |
| AutoRenewFlag | Yes | Integer | Specifies the auto-renewal flag. this parameter is valid only when the billing mode is prepaid. Valid values:. - 0: specifies manual renewal.- 1: specifies auto-renewal.Default value: 0 |
| VpcId | Yes | String | VPC ID in the format of vpc-xxxxxxx, which can be obtained in the console or from the unVpcId field in the return value of the DescribeVpcEx API. |
| SubnetId | Yes | String | VPC subnet ID in the format of subnet-xxxxxxxx, which can be obtained in the console or from the unSubnetId field in the return value of the DescribeSubnets API. |
| Name | No | String | Specifies the instance name for new purchase, only supports chinese/english/digits/"_"/"-" with length less than 60. displays "source instance name-Copy" by default if no instance name is specified. |
| InstanceChargeType | No | String | Instance billing type, which currently supports: - PREPAID: Prepaid, i.e., yearly/monthly subscription - POSTPAID_BY_HOUR: Pay-as-you-go, i.e., pay by consumption Default value: PREPAID |
| SecurityGroupIds.N | No | Array of String | Security group to which an instance belongs. obtain this parameter by calling the SecurityGroupId field in the return value of DescribeSecurityGroups. if not specified, the default security group is bound. |
| ProjectId | No | Integer | Project ID. default value is 0, which means it belongs to the default project. |
| TagList.N | No | Array of Tag | The information of tags to be bound with the instance, which is left empty by default. This parameter can be obtained from the Tags field in the return value of the DescribeTags API. |
| DBNodeSet.N | No | Array of DBNode | Deployment information of instance nodes. the availability zone of primary and secondary nodes is required. when multi-availability zone deployment is supported, the availability zone information for each node must be specified. AZ information can be obtained by calling the DescribeZones api (https://www.tencentcloud.comom/document/api/409/16769?from_cn_redirect=1) and checking the Zone field in the returned value. |
| AutoVoucher | No | Integer | Whether to automatically use coupons: - 0: No - 1: Yes Default value: 0 |
| VoucherIds | No | String | Voucher ID list. |
| ActivityId | No | Integer | Campaign ID. |
| BackupSetId | No | String | Basic backup set ID. either BackupSetId or RecoveryTargetTime must be provided, and cannot include both. |
| RecoveryTargetTime | No | String | Specifies the recovery time point. either BackupSetId or RecoveryTargetTime must be provided, and cannot include both. |
| SyncMode | No | String | Primary-standby sync mode, which supports: Default value for the primary instance: Semi-sync Default value for the read-only instance: Async |
| DeletionProtection | No | Boolean | Specifies whether to enable deletion protection for the instance. valid values: true (enable deletion protection), false (disable deletion protection). |
| Parameter Name | Type | Description |
|---|---|---|
| DealName | String | Order number. |
| BillId | String | Order transaction number. |
| DBInstanceId | String | Specifies the instance ID of the cloned instance. only support postpaid return this value. |
| 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. |
This example shows you how to restore data by cloning an instance when the source instance is accidentally deleted.
POST / HTTP/1.1
Host: postgres.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CloneDBInstance
<Common request parameters>
{
"VpcId": "vpc-2ot3acw1",
"AutoRenewFlag": 1,
"DBInstanceId": "postgres-abcd1234",
"RecoveryTargetTime": "2021-12-25 01:27:35",
"Storage": 10,
"Period": 1,
"AutoVoucher": 0,
"InstanceChargeType": "prepaid",
"SpecCode": "cdb.pg.z1.2g",
"SubnetId": "subnet-ppv9iw34",
"DBNodeSet": [
{
"Role": "Standby",
"Zone": "ap-guangzhou-3"
},
{
"Role": "Primary",
"Zone": "ap-guangzhou-3"
}
]
}
{
"Response": {
"RequestId": "6ace8140-6b9e-4e81-a8ad-ef3f92b2aa90",
"DealName": "20211225711000768276461",
"BillId": "20211225711000768276471",
"DBInstanceId": "postgres-xxxx"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.AllocateQuotasError | Failed to request a quota for resource tags. |
| FailedOperation.CamAuthFailed | CAM authentication failed. |
| FailedOperation.CamSigAndAuthError | Authentication failed. Please try again later. If the problem persists, please contact customer service. |
| FailedOperation.CdbCgwConnectError | Failed to get project information. 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.DatabaseAffectedError | Data operation failed. Please contact customer service. |
| FailedOperation.FailedOperationError | Operation failed. Please try again later. |
| FailedOperation.GetSubnetError | Failed to query VPC subnets. |
| FailedOperation.GetVpcInfoError | Failed to query VPC information. Please try again later. If the problem persists, please contact customer service. |
| FailedOperation.QuerySpecError | Failed to query specifications. Please try again later. If the problem persists, please contact customer service. |
| FailedOperation.QueryVpcFailed | Failed to query VPC. |
| FailedOperation.QueryVpcFalied | Failed to get VPC details. |
| InternalError.InternalHttpServerError | An exception occurred while executing the request. |
| InternalError.JsonParseError | Json data parsing failed. contact our customer service for assistance. |
| InvalidParameter.ParameterCheckError | Failed to check the parameter. |
| InvalidParameterValue.IllegalProjectId | Invalid ProjectId. |
| InvalidParameterValue.IllegalRegion | Invalid Region parameter. |
| InvalidParameterValue.IllegalZone | Invalid Zone parameter. |
| InvalidParameterValue.InvalidParameterValueError | Incorrect parameter value |
| InvalidParameterValue.InvalidZoneIdError | Invalid availability zone. |
| InvalidParameterValue.SpecNotRecognizedError | Failed to identify the specification ({{1}}). |
| OperationDenied.CamDeniedError | This operation cannot be performed. |
| OperationDenied.InstanceStatusLimitError | This operation cannot be performed on an instance in this status. |
| OperationDenied.InsufficientBalanceError | Insufficient account balance. |
| OperationDenied.TradePermissionError | No payment permission. activation failed. |
| OperationDenied.UserNotAuthenticatedError | You need to verify your identity to make a purchase. |
フィードバック