1. 接口描述
接口请求域名： cdwch.tencentcloudapi.com 。
查询备份策略信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeBackUpSchedule。 |
| Version | 是 | String | 公共参数，本接口取值：2020-09-15。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 集群id 示例值："cdwch-xxxx" |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| BackUpOpened | Boolean | 备份是否开启 示例值：true |
| MetaStrategy | ScheduleStrategy | 元数据备份策略 |
| DataStrategy | ScheduleStrategy | 表数据备份策略 |
| BackUpContents | Array of BackupTableContent | 备份表列表 |
| BackUpStatus | Integer | 备份的状态 示例值：0 |
| ErrorMsg | String | 错误信息 示例值：InvalidParameter |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
查询备份策略信息
输入示例
POST / HTTP/1.1
Host: cdwch.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackUpSchedule
<公共请求参数>
{
"InstanceId": "cdwch-1a1xfbc"
}输出示例
{
"Response": {
"BackUpOpened": true,
"MetaStrategy": {
"CosBucketName": "pa-cold-test-1258142303",
"RetainDays": 1,
"WeekDays": "2",
"ExecuteHour": 5,
"ScheduleId": 1,
"NextBackupTime": "2021-01-10 12:00:00"
},
"DataStrategy": {
"CosBucketName": "pa-cold-test-1268142801",
"RetainDays": 2,
"WeekDays": "1",
"ExecuteHour": 8,
"ScheduleId": 13
},
"BackUpContents": [
{
"VCluster": "default_cluster",
"Database": "default",
"Table": "stemp",
"TotalBytes": 1231270,
"Ips": "10.0.1.23",
"Rip": "192.x.x.x",
"ZooPath": "/data"
}
],
"BackUpStatus": 0,
"ErrorMsg": "",
"RequestId": "asdfaes-xad12x-123axafg"
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
