调用ModifyBackupPolicy接口修改集群的备份策略。
接口说明
当前服务的接入地址请参见服务接入点。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
adb:ModifyBackupPolicy | update |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBClusterId | string | 是 | 企业版、基础版或湖仓版集群 ID。 | am-bp1xxxxxxxx47 |
PreferredBackupTime | string | 是 | 执行全量备份的开始时间,格式为 HH:mmZ-HH:mmZ(UTC 时间)。 说明
时间范围限制为 1 小时。
| 18:00Z-19:00Z |
PreferredBackupPeriod | string | 是 | 全量备份周期,多个取值用英文逗号(,)隔开。取值说明:
说明
为保证数据安全,最少选择两个。
| Monday,Wednesday,Friday,Sunday |
BackupRetentionPeriod | string | 否 | 全量备份保留天数,取值范围为:7~730。 说明
本参数不填写,默认为 7 天。
| 7 |
EnableBackupLog | string | 否 | 是否开启日志(实时)备份。取值说明:
说明
本参数不填写,默认开启。
| Enable |
LogBackupRetentionPeriod | integer | 否 | 日志(实时)数据备份保留天数,取值范围为:7~730。 说明
本参数不填写,默认为 7 天。
| 7 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidDBClusterId.NotFound | The DBClusterId provided does not exist in our records. | 您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。 |
400 | InvalidDBClusterId.Malformed | The specified parameter DBClusterId is not valid. | DBClusterId参数不正确,请确认参数是否符合规范。 |
400 | InvalidPreferredBackupTime.Malformed | The specified parameter PreferredBackupTime is not valid. | PreferredBackupTime参数不正确,请确认参数是否符合规范。 |
400 | InvalidPreferredBackupPeriod.Malformed | The specified parameter PreferredBackupPeriod is not valid. | PreferredBackupPeriod |
400 | InvalidBackupRetentionPeriod.Malformed | The specified parameter "BackupRetentionPeriod" should be within [7-%s] days. | 数据备份保留天数错误:%s |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-10-12 | OpenAPI 错误码发生变更 | 查看变更详情 |
2024-10-12 | OpenAPI 错误码发生变更 | 查看变更详情 |