TDSQL-C MySQL 版修改保险箱

1. 接口描述

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

修改备份保险箱配置，包括名称、描述、保留时长、加密密钥、锁定时间等

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyVault。
Version	是	String	公共参数，本接口取值：2019-01-07。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo 。
VaultId	是	String	保险箱ID 示例值：vault-8b430b41-74e0-4c95-82c7-e2dfc50e21d6
VaultName	否	String	保险箱名称，最大255字符示例值：create
VaultDescribe	否	String	保险箱描述，最大1024字符示例值：modify
BackupSaveSeconds	否	Integer	备份保留时长（秒），范围: (0, 632448000] 示例值：604800
KeyId	否	String	加密密钥ID，最大36字符示例值：90200ee5-f2aa-47bb-8a0b-450f58e0a58f
KeyType	否	String	密钥类型，可选值: cloud、custom 示例值：custom
KeyRegion	否	String	密钥所在地域，最大32字符示例值：ap-guangzhou
IsLock	否	Boolean	是否锁定保险箱示例值：true
LockedTime	否	String	锁定到期时间，格式: 2006-01-02 15:04:05，锁定时间距当前最多15天示例值：2026-03-16 20:00:00
IsEncryption	否	Boolean	是否加密示例值：true

3. 输出参数

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

4. 示例

示例1 修改保险箱名称

输入示例

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

{
    "VaultId": "vault-bb80705c-e6cb-4e40-b9f6-93e540a50f61",
    "BackupSaveSeconds": 600
}

输出示例

{
    "Response": {
        "TaskId": 4295126097,
        "RequestId": "7968c0b3-88e6-4ad5-b8a0-cf5fde099627"
    }
}

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: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
OperationDenied.BackupVaultTaskConflictError	备份保险箱资源 {{1}} 处于{{2}}中无法进行{{3}}的操作

修改保险箱

本页目录：