腾讯云数据仓库 TCHouse-D 获取备份、迁移任务

一、1. 接口描述

获取备份、迁移的调度任务信息

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

二、2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeBackUpSchedules。
Version	是	String	公共参数，本接口取值：2021-12-28。
Region	是	String	公共参数，详见产品支持的地域列表。
ApplicationType	否	Integer	任务类型0-不限制，或使用TypeFilters过滤；1-备份恢复（包括周期备份和一次性备份）；2-数据迁移（包括跨集群迁移和cos迁移）示例值：1
UsersFilters.N	否	Array of String	创建人过滤器示例值：["14311"]
TypeFilters.N	否	Array of Integer	任务类型过滤器。0-周期；1-一次性；2-数据迁移(即3和4的合集)；3-远端集群迁移；4-COS迁移示例值：[1]
StatusFilters.N	否	Array of Integer	任务状态过滤器示例值：[1]
OrderType	否	String	排序：DESC-降序ASC-升序示例值：DESC
ScheduleNameFilters	否	String	任务名过滤器示例值：jobname
PageSize	否	Integer	分页大小示例值：1
PageNum	否	Integer	页号示例值：1
EncryptionFilters.N	否	Array of Integer	0-未加密；1-已加密示例值：[1]
ScheduleId	否	Integer	调度任务id过滤示例值：312

三、3. 输出参数

参数名称	类型	描述
BackUpOpened	Boolean	备份是否开启示例值：true
CosBucketName	String	备份桶示例值：bucketname
BackUpStatus	Integer	备份的状态示例值：0
BackupScheduleInfos	Array of BackupScheduleInfo	备份、迁移任务信息
CurrentTime	String	当前系统时间示例值："2025-11-11 11:06:16"
BucketEncryption	BucketEncryptionInfo	桶加密状态信息
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

四、输入示例

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

五、输出示例

{
"Response": {
"BackUpOpened": true,
"BackUpStatus": 0,
"BackupScheduleInfos": [
{
"BackupType": 0,
"BucketEncryption": {
"EncryptionType": "disabled",
"IsEncrypted": false,
"LastOperation": "",
"LastUpdateTime": ""
},
"BucketType": "standard",
"CosSourceInfo": "dNWAedGPDTTCZjC95G2i5A==",
"DataRemoteRegion": "",
"DorisSourceInfo": "dNWAedGPDTTCZjC95G2i5A==",
"EnableSecurityLock": 0,
"ExistCount": 1,
"GracePeriod": 0,
"GraceStartTime": "",
"InstanceId": "cdwdoris-wmkiloz9",
"InstanceName": "liuming-yunti-test2",
"InstanceStatus": "Serving",
"InstanceStatusDesc": "运行中",
"IsWithinGracePeriod": true,
"RestoreType": 0,
"SnapshotRemainPolicy": {
"RemainDays": 0,
"RemainDaysUnit": 0,
"RemainLatestNum": 0,
"Type": 0
}
}
],
"CosBucketName": "",
"CurrentTime": "2026-03-12 19:09:36",
"RequestId": "3bf34b8b-bac3-4474-ad5d-631664d70fb3"
}
}

六、腾讯云 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. 错误码

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

错误码	描述
InvalidParameter	参数错误。
UnsupportedOperation	操作不支持。