1. 接口描述
接口请求域名: postgres.tencentcloudapi.com 。
根据备份集或恢复目标时间,在原实例上恢复数据库相关对象,例如数据库、表。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:RestoreDBInstanceObjects。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
DBInstanceId | 是 | String | 实例ID。 示例值:postgres-abcd1234 |
RestoreObjects.N | 是 | Array of String | 需要恢复的对象列表。假设需要恢复的对象名为test,则恢复后的名称为test_bak_${LinuxTime}。${LinuxTime}无法指定,由系统根据任务发起的linux时间设定。 示例值:["test"] |
BackupSetId | 否 | String | 恢复所用备份集。BackupSetId与RestoreTargetTime有且只能传一个。 示例值:db468966-a8d8-5831-8596-763a7833e380 |
RestoreTargetTime | 否 | String | 恢复目标时间,北京时间。BackupSetId与RestoreTargetTime有且只能传一个。 示例值:2024-04-30 00:20:27 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 指定恢复时间,恢复数据库对象
在原实例上指定恢复时间,恢复某些数据库相关对象。例如在postgres-abcd1234实例上,恢复时间点2024-03-25 01:27:35上的test数据库。
输入示例
POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RestoreDBInstance
<公共请求参数>
{
"DBInstanceId": "postgres-abcd1234",
"RestoreTargetTime": "2024-03-25 01:27:35",
"RestoreObjects": [
"test"
]
}
输出示例
{
"Response": {
"RequestId": "6ace8140-6b9e-4e81-a8ad-ef3f92b2aa90"
}
}
示例2 选定备份集,恢复数据库对象
在原实例上选定备份集,恢复某些数据库相关对象。例如在postgres-abcd1234实例上,使用备份集28aa61ac-1b1f-566a-bedb-6e918024be02恢复test数据库。
输入示例
POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RestoreDBInstance
<公共请求参数>
{
"DBInstanceId": "postgres-abcd1234",
"BackupSetId": "28aa61ac-1b1f-566a-bedb-6e918024be02",
"RestoreObjects": [
"test"
]
}
输出示例
{
"Response": {
"RequestId": "3d49f48c-7d27-4820-8724-ed5b15787373"
}
}
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.DatabaseAccessError | 管控元数据库访问失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
FailedOperation.FailedOperationError | 操作失败,请稍后重试。 |
FailedOperation.FlowCreateError | 创建流程失败,请稍后重试。如果持续不成功,请联系客服进行处理。 |
InvalidParameterValue.ParameterHandleError | 参数处理失败,请检参数值设置是否有效。 |
OperationDenied.InstanceAccessDeniedError | 您没有权限操作当前资源。 |
OperationDenied.InstanceStatusLimitError | 实例当前状态限制本次操作。 |
OperationDenied.InstanceStatusLimitOpError | 实例状态限制当前操作。 |
ResourceNotFound.InstanceNotFoundError | 实例不存在。 |