创建定期备份策略
最近更新时间: 2024-09-03 18:49:42
1. 接口描述
接口请求域名： brc.api3.cloud.sunhongs.com。
本接口（CreateAutoBackupPolicy）用于创建定期备份策略。
默认接口请求频率限制：20次/秒。
接口更新时间：2023-04-06 10:37:43。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：CreateAutoBackupPolicy |
| Version | 是 | 否 | String | 公共参数，本接口取值：2022-05-16 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| Policy | 是 | 否 | Array of Policy | 定期备份的执行策略。 |
| IsPermanent | 否 | 否 | Bool | 通过该定期备份策略创建的备份是否永久保留。false表示非永久保留，true表示永久保留，默认为false。 |
| AutoBackupPolicyName | 否 | 否 | String | 定期备份策略的名称。 |
| IsActivated | 否 | 否 | Bool | 是否激活定期备份策略。 |
| RetentionDays | 否 | 否 | Uint64 | 通过定期备份策略创建出的备份保留时间。 |
| DryRun | 否 | 否 | Bool | 是否实际创建定期备份策略。true表示只需获取首次开始备份的时间，不实际创建定期备份策略，false表示创建，默认为false。 |
| RetentionMonths | 否 | 否 | Uint64 | 该定期备份策略创建的备份可以保留的月数，该参数不可与IsPermanent/RetentionDays参数冲突。 |
| RetentionAmount | 否 | 否 | Uint64 | 通过该定期备份策略最多保留的备份个数，超过该个数限制后自动删除最先创建的备份，该参数不可与IsPermanent参数冲突。 |
| AdvancedRetentionPolicy | 否 | 否 | AdvancedRetentionPolicy | 定期备份高级保留策略，该参数不可与IsPermanent参数冲突。 |
| CreateSpeed | 否 | 否 | Uint64 | 创建备份的带宽上限，范围:[0, 100] |
| FullBackupInterval | 否 | 否 | Int64 | 每隔几个备份做一个全量备份，0表示全部做全量备份。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| AutoBackupPolicyId | String | 定期备份策略ID。 |
| NextTriggerTime | Datetime | 首次开始备份的时间。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.MissingParameter | |
| InvalidParameterValue.InvalidAction | |
| InvalidParameterValue.InvalidValue |