1. 接口描述
接口请求域名： cdwdoris.tencentcloudapi.com 。
创建或者修改备份策略
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateBackUpSchedule。 |
| Version | 是 | String | 公共参数，本接口取值：2021-12-28。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 集群id 示例值："cdwch-xxx" |
| OperationType | 是 | String | 操作类型 create(创建) update(编辑修改) 示例值："create" |
| ScheduleId | 否 | Integer | 编辑时需要传 示例值：12345 |
| WeekDays | 否 | String | 选择的星期 逗号分隔 废弃：使用ScheduleInfo 示例值："1,2" |
| ExecuteHour | 否 | Integer | 执行小时 废弃：使用ScheduleInfo 示例值：1 |
| BackUpTables.N | 否 | Array of BackupTableContent | 备份表列表 示例值：["123"] |
| BackupType | 否 | Integer | 0为默认。1时是对远端的doris进行备份，不周期，一次性 示例值：1 |
| DorisSourceInfo | 否 | DorisSourceInfo | 远端doris集群的连接信息 示例值：{} |
| BackupTimeType | 否 | Integer | 0为默认。1时是一次性备份。2时是远端备份 示例值：1 |
| RestoreType | 否 | Integer | 0为默认。1时是备份完成后立即恢复 示例值：1 |
| AuthType | 否 | Integer | 0为默认。1时是提供自定义的secret连接cos 示例值：1 |
| CosSourceInfo | 否 | CosSourceInfo | cos认证的信息 示例值：1 |
| ScheduleName | 否 | String | 调度任务名 示例值：表1备份 |
| ScheduleInfo | 否 | ScheduleInfo | 调度信息 |
| UpdateStatus | 否 | Integer | 更新任务状态： 3-暂停, 2-删除, 1-启动 示例值：1 |
| CosBucket | 否 | String | 当前任务的cos桶信息 示例值：carson-test-1301087413 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
输入示例
POST / HTTP/1.1
Host: cdwdoris.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBackUpSchedule
<公共请求参数>
{
"ScheduleId": 0,
"InstanceId": "1",
"WeekDays": "1",
"BackUpTables": [
{
"Table": "1",
"TotalBytes": 0,
"Database": "1"
}
],
"ExecuteHour": 0,
"OperationType": "1"
}输出示例
{
"Response": {
"RequestId": "1"
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
