DescribeDBSCloneInstances

Last updated:2026-03-13 18:56:40

DescribeDBSCloneInstances

Last updated: 2026-03-13 18:56:40

1. API Description

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

Query clone list of instances.

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: DescribeDBSCloneInstances.
Version	Yes	String	Common Params. The value used for this API: 2021-11-22.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
SourceInstanceId	Yes	String	Source instance ID.
DBType	No	String	Engine type
EndCreateTime	No	String	Creation end time
FilterCloneType	No	String	Clone kind: PITR time point BackupSet backup set
Limit	No	Integer	Query count [0,200]
Offset	No	Integer	Query offset [0,INF]
OrderBy	No	String	Sorting field: CloneTime, CreateTime
OrderType	No	String	Sorting type: ASC, DESC
StartCreateTime	No	String	Creation start time

3. Output Parameters

Parameter Name	Type	Description
Items	Array of CloneInstanceModel	Clone list . Note: This field may return null, indicating that no valid values can be obtained.
TotalCount	Integer	Total
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 Query the Clone List of an Instance

Query the clone list of an instance

Input Example

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

{
    "SourceInstanceId": "tdsql3-86b3580b"
}

Output Example

{
    "Response": {
        "Items": [
            {
                "CloneEndTime": "2025-12-24 11:40:15",
                "CloneId": 652,
                "CloneInsType": "Normal",
                "CloneInstanceId": "tdsql3-c0dba2de",
                "CloneInstanceIsDeleted": false,
                "CloneProgress": 100,
                "CloneStartTime": "2025-12-24 11:15:35",
                "CloneStatus": "Recovered",
                "CloneTime": "2025-12-24 11:10:53",
                "CloneType": "BackupSet",
                "CreateTime": "2025-12-24 11:15:35",
                "DBType": "tdstore",
                "Region": "ap-chengdu",
                "SourceInstanceId": "tdsql3-86b3580b"
            }
        ],
        "TotalCount": 1,
        "RequestId": "76d4fb20-084c-46fb-99f2-6e32dfa420ea"
    }
}

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

Tencent Cloud CLI 3.0

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
InternalError.DatabaseAccessError	Database access error.
InternalError.RouterNotFound	Route not found. whether parameter passing is incorrect.
ResourceNotFound.BizResourceNotFoundError	Instance resource not found.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud