tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

ImportSnapshots

最后更新时间：2024-07-24 10:20:13

    1. API Description

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

    This API is used to import a snapshot into a new table or the original table from which the snapshot was created.

    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: ImportSnapshots.
    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 original table (from which the snapshot was created) resides
    Snapshots Yes SnapshotInfo The information of the snapshot to import
    ImportSpecialKey Yes String Whether to import partial data of the snapshot. Valid values: TRUE (import partial data), FALSE (import all data).
    ImportOriginTable Yes String Whether to import to the original table. Valid values: TRUE (import to the original table), FALSE (import to a new table).
    KeyFile No KeyFile The file of the keys of the partial data
    NewTableGroupId No String The ID of the table group where the new table resides, which is valid only when ImportOriginTable is set to FALSE
    NewTableName No String The name of the new table, which is valid only when ImportOriginTable is set to FALSE. TcaplusDB will automatically create a table named NewTableName of the same structure as that of the original table.

    3. Output Parameters

    Parameter Name Type Description
    TaskId String TaskId is in the format of AppInstanceId-taskId, used to identify tasks of different clusters.
    Note: null may be returned for this field, indicating that no valid values can be obtained.
    ApplicationId String ApplicationId is in the format of AppInstanceId-applicationId, which is used to identify applications of different clusters.
    Note: This field may return null, indicating that no valid values can be obtained.
    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 Importing a snapshot

    This example shows you how to import a snapshot.

    Input Example

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

{
    "ClusterId": "abc",
    "Snapshots": {
        "TableGroupId": "abc",
        "TableName": "abc",
        "SnapshotName": "abc",
        "SnapshotTime": "2020-09-22 00:00:00",
        "SnapshotDeadTime": "2020-09-22 00:00:00"
    },
    "ImportSpecialKey": "abc",
    "KeyFile": {
        "FileName": "abc",
        "FileExtType": "abc",
        "FileContent": "abc",
        "FileSize": 0
    },
    "ImportOriginTable": "abc",
    "NewTableGroupId": "abc",
    "NewTableName": "abc"
}

    Output Example

    {
    "Response": {
        "TaskId": "abc",
        "ApplicationId": "abc",
        "RequestId": "abc"
    }
}

    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.
    LimitExceeded The quota limit is exceeded.
    MissingParameter Missing parameter.
    ResourceInsufficient.BalanceError Insufficient balance.
    ResourceNotFound The resource does not exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款