导入快照数据

最近更新时间:2025-08-19 02:43:44

我的收藏

1. 接口描述

接口请求域名: tcaplusdb.tencentcloudapi.com 。

将快照数据导入到新表或当前表

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ImportSnapshots。
Version String 公共参数,本接口取值:2019-08-23。
Region String 公共参数,详见产品支持的 地域列表
ClusterId String 表格所属的集群id
示例值:346673
Snapshots SnapshotInfo 用于导入的快照信息
示例值:{}
ImportSpecialKey String 是否导入部分记录,TRUE表示导入部分记录,FALSE表示全表导入
示例值:testkey
ImportOriginTable String 是否导入到当前表,TRUE表示导入到当前表,FALSE表示导入到新表
示例值:testname
KeyFile KeyFile 部分记录的key文件
示例值:{}
NewTableGroupId String 如果导入到新表,此为新表所属的表格组id
示例值:56336
NewTableName String 如果导入到新表,此为新表的表名,系统会以该名称自动创建一张结构相同的空表
示例值:testnewname

3. 输出参数

参数名称 类型 描述
TaskId String TaskId由 AppInstanceId-taskId 组成,以区分不同集群的任务
示例值:11843324
ApplicationId String ApplicationId由 AppInstanceId-applicationId 组成,以区分不同集群的申请
示例值:0
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 导入快照

导入快照数据

输入示例

POST / HTTP/1.1
Host: tcaplusdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ImportSnapshots
<公共请求参数>

{
    "ClusterId": "1837232",
    "Snapshots": {
        "TableGroupId": "1",
        "TableName": "testname",
        "SnapshotName": "snapshotname",
        "SnapshotTime": "2020-09-22 00:00:00",
        "SnapshotDeadTime": "2020-09-22 00:00:00"
    },
    "ImportSpecialKey": "spkey",
    "KeyFile": {
        "FileName": "filename",
        "FileExtType": "txt",
        "FileContent": "content",
        "FileSize": 12130
    },
    "ImportOriginTable": "origintable",
    "NewTableGroupId": "newtable",
    "NewTableName": "newname"
}

输出示例

{
    "Response": {
        "TaskId": "35452",
        "ApplicationId": "134425",
        "RequestId": "232523-121452"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
AuthFailure.UnauthorizedOperation 接口操作鉴权错误。
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
ResourceInsufficient.BalanceError 余额不足。
ResourceNotFound 资源不存在。