tencent cloud

All product documents
TencentDB for SQL Server
DocumentationTencentDB for SQL ServerAPI DocumentationDatabase APIsCloneDB
CloneDB
Download PDF
Last updated: 2024-11-26 16:33:28
CloneDB
Last updated: 2024-11-26 16:33:28
Download PDF

1. API Description

Domain name for API request: sqlserver.intl.tencentcloudapi.com.

This API is used to clone and rename databases of an instance. The clones are still in the instance from which they are cloned.

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: CloneDB.
Version Yes String Common Params. The value used for this API: 2018-03-28.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceId Yes String Instance ID in the format of mssql-j8kv137v
RenameRestore.N Yes Array of RenameRestoreDatabase Clone and rename the databases specified in ReNameRestoreDatabase. Please note that the clones must be renamed.

3. Output Parameters

Parameter Name Type Description
FlowId Integer Async task request ID, which can be used in the DescribeFlowStatus API to query the execution result of an async task
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 Cloning a database

Input Example

https://sqlserver.intl.tencentcloudapi.com/?Action=CloneDB
&InstanceId=mssql-njj2mtpl
&RenameRestore.0.OldName=db1
&RenameRestore.0.NewName=clone_db1
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "4be5990d-a4b5-49dc-b2b4-e713b6aa7ba3",
        "FlowId": 3546
    }
}

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.DBError Database error.
FailedOperation.GcsError The operation failed or the network timed out.
InternalError.CreateFlowFailed Failed to create flow.
InternalError.DBConnectError Database connection error.
InternalError.SystemError System error.
InternalError.UnknownError Unknown error.
InvalidParameter.InputIllegal Input error.
InvalidParameter.ParamsAssertFailed An error occurred while converting parameter assertion.
InvalidParameterValue.BackupNameIsIllegal The backup name contains invalid characters.
InvalidParameterValue.DBCharIllegal The database name contains invalid characters.
InvalidParameterValue.DBExist The database already exists.
InvalidParameterValue.DBNameIsKeyWrods The database name cannot contain reserved words.
InvalidParameterValue.DBNameSame The new database name is the same as the old one.
InvalidParameterValue.ParameterTypeError Incorrect parameter type.
LimitExceeded.TooManyDB The database limit is exceeded.
ResourceNotFound.DBNotExit The database does not exist.
ResourceNotFound.DBNotFound The database does not exist.
ResourceNotFound.InstanceNotFound The instance does not exist.
ResourceUnavailable.DBInvalidStatus Invalid database status.
ResourceUnavailable.InstanceStatusInvalid Invalid instance status.
UnauthorizedOperation.PermissionDenied CAM authentication error.
UnknownParameter Unknown parameter error
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