tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeSnapshots

Last updated: 2024-07-24 10:20:18

    1. API Description

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

    This API is used to query the list of table snapshots.

    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: DescribeSnapshots.
    Version Yes String Common Params. The value used for this API: 2019-08-23.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    ClusterId Yes String The ID of the cluster where the table resides
    TableGroupId No String The ID of the table group where the table resides
    TableName No String Table name
    SnapshotName No String Snapshot name
    SelectedTables.N No Array of SelectedTableInfoNew The list of snapshots pulled in batches

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer The number of snapshots
    TableResults Array of SnapshotResult The result list of snapshots
    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 list of table snapshots

    This example shows you how to query the list of table snapshots.

    Input Example

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

{
    "ClusterId": "18685341856",
    "TableGroupId": "1",
    "TableName": "cl_generic"
}

    Output Example

    {
    "Response": {
        "TotalCount": 1,
        "TableResults": [
            {
                "SnapshotCreateTime": "2020-09-22 00:00:00",
                "TableGroupId": "1",
                "SnapshotSize": 1,
                "SnapshotName": "test",
                "SnapshotTime": "2020-09-22 00:00:00",
                "TableName": "cl_generic",
                "SnapshotStatus": 1,
                "TaskId": "xx",
                "Error": {
                    "Message": "xx",
                    "Code": "xx"
                },
                "SnapshotDeadTime": "2020-09-22 00:00:00"
            }
        ],
        "RequestId": "xx"
    }
}

    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 CAM signature/authentication error
    AuthFailure.UnauthorizedOperation API operation authentication error.
    FailedOperation Operation failed.
    InternalError Internal error.
    InvalidParameter Invalid parameter.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.InvalidAppName Invalid cluster name
    ResourceInsufficient Insufficient resources.
    ResourceNotFound The resource does not exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy