TDSQL-C MySQL 版查询备份保险箱列表，支持分页、筛

1. 接口描述

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

查询备份保险箱列表，支持分页、筛选和排序

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeVaults。
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 。
VaultIds.N	否	Array of String	保险箱ID列表，用于精确筛选示例值：["vault-01b0a50a-33b5-4104-8d10-e55a79d10562"]
VaultName	否	String	保险箱名称，用于模糊筛选示例值：create
Status.N	否	Array of String	保险箱状态列表，用于筛选示例值：["running"]
Limit	否	Integer	每页数量，范围(0,100]，默认100 示例值：2
Offset	否	Integer	偏移量，范围[0,+∞)，默认0 示例值：0
OrderBy	否	String	排序字段，可选值：VaultId, VaultName, BackupSaveSeconds, LockedTime, CreateTime, UpdateTime 示例值：vaultId
OrderByType	否	String	排序方式，可选值：desc, asc, DESC, ASC 示例值：desc

3. 输出参数

参数名称	类型	描述
Vaults	Array of DescribeVaultsItem	保险箱列表
TotalCount	Integer	总数量示例值：0
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询保险箱列表

输入示例

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

{}

输出示例

{
    "Response": {
        "TotalCount": 229,
        "Vaults": [
            {
                "AutoCopyConfigs": [
                    {
                        "ClusterId": "cynosdbmysql-03e2xlyd",
                        "CopyType": "binlog",
                        "VaultId": "vault-a6ed23f2-f03e-4410-b946-624d1e7d9b5a",
                        "VaultRegion": "ap-guangzhou"
                    }
                ],
                "BackupFileCount": 1,
                "BackupFileSize": 4183356,
                "BackupSaveSeconds": 604800,
                "BinlogFileCount": 9,
                "BinlogFileSize": 1320651467,
                "RedoLogFileCount": 3,
                "RedoLogFileSize": 1123284320,
                "Status": "running",
                "Tasks": [],
                "VaultId": "vault-a6ed23f2-f03e-4410-b946-624d1e7d9b5a",
                "VaultName": "testtttt",
                "VaultRegion": "ap-guangzhou"
            }
        ],
        "RequestId": "af30455b-61bd-495c-b751-e43a47978c1d"
    }
}

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. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。