云数据库 KeeWiDB 手动发起备份-备份相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： keewidb.tencentcloudapi.com 。

手动发起备份

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateBackupManually。
Version	是	String	公共参数，本接口取值：2022-03-08。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	待操作的实例 ID，可通过 DescribeInstance接口返回值中的 InstanceId 获取。示例值：kee-7iw94215
Remark	否	String	本次备份的备注信息。示例值：备份test
StorageDays	否	Integer	备份文件保存天数。0代表指定默认保留时间示例值：7

3. 输出参数

参数名称	类型	描述
TaskId	Integer	任务 ID。示例值：6954227
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例1

输入示例

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

{
    "InstanceId": "kee-lagg27el",
    "StorageDays": "14",
    "Remark": "备份test"
}

输出示例

{
    "Response": {
        "RequestId": "9275a3b1-565a-4a0d-90c4-4cd39421160f",
        "TaskId": 1655902385
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.SystemError	内部系统错误，和业务无关。
InternalError.InternalError	内部错误。
InvalidParameter.InvalidParameter	业务参数错误。
InvalidParameter.PermissionDenied	接口没有cam权限。
ResourceNotFound.InstanceNotExists	找不到对应实例
ResourceUnavailable.InstanceLockedError	实例已经被其它流程锁定。
ResourceUnavailable.InstanceStateError	实例状态错误。
ResourceUnavailable.InstanceStatusAbnormal	实例状态异常，不能执行对应流程。