1. 接口描述
接口请求域名: cdwdoris.tencentcloudapi.com 。
备份恢复
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:RecoverBackUpJob。 |
Version | 是 | String | 公共参数,本接口取值:2021-12-28。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 集群id 示例值:"cdwch-xxx" |
BackUpJobId | 是 | Integer | 任务id 示例值:36613 |
ReplicationNum | 否 | Integer | 恢复出来的新表副本数 示例值:3 |
ReserveSourceConfig | 否 | Integer | 恢复是否保持源表中的配置,1时表示保留源表中的配置 示例值:1 |
RecoverScope | 否 | String | 恢复粒度:All全量、Database按库、Table按表 示例值:All |
RecoverDatabase | 否 | String | 恢复库:如果是按库备份,则需要该字段,库之间用","分割 示例值:db1 |
ReserveStoragePolicy | 否 | Integer | 1:恢复后,不保留降冷策略,数据变为热数据; 2:恢复后,沿用备份表的降冷策略; 0:默认值,该版本没有这个配置(2.1版本2.1.8之前;2.0版本2.0.16之前) 示例值:2 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 恢复任务总数量 示例值:10 |
DuplicateTables | Array of String | 重复的表名 示例值:['tb1','tb2'] |
ErrorMsg | String | 错误信息 示例值:this is error |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
输入示例
POST / HTTP/1.1
Host: cdwdoris.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RecoverBackUpJob
<公共请求参数>
{
"InstanceId": "1",
"BackUpJobId": 0
}
输出示例
{
"Response": {
"RequestId": "1"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。