1. 接口描述
接口请求域名: mongodb.tencentcloudapi.com 。
该接口用于发起按 Key 闪回任务,依据数据的闪回 Key(默认为 id)对数据进行极速回档,快速恢复业务。
说明:按 Key 闪回于2023年09月11日正式进行公测,在此期间,该接口仅对公测用户开放。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:FlashBackDBInstance。 |
Version | 是 | String | 公共参数,本接口取值:2019-07-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 开启按 Key 回档的实例 ID。 示例值:cmgo-igjysqkr |
TargetFlashbackTime | 是 | String | 源数据想恢复到的时间。 示例值:2023-08-04 14:00:00 |
TargetDatabases.N | 是 | Array of FlashbackDatabase | 源数据所在的库表信息。 |
TargetInstanceId | 否 | String | 数据最终写入的实例 ID。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
FlowId | Integer | 回档数据异步任务 ID。 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 执行按key回档
输入示例
POST / HTTP/1.1
Host: mongodb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: FlashBackDBInstance
<公共请求参数>
{
"InstanceId": "cmgo-igjysqkr",
"TargetFlashbackTime": "2023-08-04 14:00:00",
"TargetDatabases": [
{
"DBName": "my_test",
"Collections": [
{
"CollectionName": "my_test1",
"KeyValues": [
{
"Key": "name",
"Value": "abc"
}
],
"TargetResultCollectionName": "my_test_bak0804143230",
"FilterKey": "name"
}
]
}
],
"TargetInstanceId": "cmgo-05173fe7"
}
输出示例
{
"Response": {
"FlowId": 1234567,
"RequestId": "abc"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.FlashbackByKeyNotOpen | 按key回档未开启 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.ParametersNil | 接口参数为空。 |
InvalidParameterValue.NotFoundInstance | 未找到实例。 |
UnsupportedOperation.KernelVersionNotSupport | 内核版本不支持。 |
UnsupportedOperation.VersionNotSupport | 当前版本不支持该操作。 |