修改存储库绑定的备份策略 - UpdateBackupPolicyInfo
功能介绍
修改存储库绑定的备份策略
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
PUT /v5/{project_id}/backup/policy
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位。 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0,表示默认企业项目(default)。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
|
region |
否 |
String |
参数解释: 区域ID,用于查询目的区域内的资产。获取方式请参见获取区域ID。 约束限制: 不涉及 取值范围: 字符长度0-128位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enabled |
否 |
Boolean |
参数解释: 策略是否启用 约束限制: 不涉及 取值范围:
默认取值: true |
|
policy_id |
是 |
String |
参数解释: 策略ID,若开启防护时开启备份防护,该字段必选。您可以通过2.7 查询HSS存储库绑定的备份策略信息接口获取ID。 约束限制: 不涉及 取值范围: 字符长度1-256 默认取值: 不涉及 |
|
operation_definition |
否 |
参数解释: 调度参数 约束限制: 不涉及 取值范围: 取值为0到100。 默认取值: 不涉及 |
|
|
trigger |
否 |
BackupTriggerRequestInfo object |
策略时间调度规则 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
day_backups |
否 |
Integer |
参数解释: 保留日备个数,该备份不受保留最大备份数限制。若选择该参数,则timezone也必选。 约束限制: 不涉及 取值范围: 取值为0到100。 默认取值: 不涉及 |
|
max_backups |
否 |
Integer |
参数解释: 单个备份对象自动备份的最大备份数。-1代表不按备份数清理。若该字段和retention_duration_days字段同时为空,备份会永久保留。 约束限制: 不涉及 取值范围: 取值为-1或1-99999 默认取值: -1 |
|
month_backups |
否 |
Integer |
参数解释: 保留月备个数,该备份不受保留最大备份数限制。若选择该参数,则timezone也必选。 约束限制: 不涉及 取值范围: 取值为0到100。 默认取值: 不涉及 |
|
retention_duration_days |
否 |
Integer |
参数解释: 备份保留时长,单位天。最长支持99999天。-1代表不按时间清理。若该字段和max_backups参数同时为空,备份会永久保留。 约束限制: 不涉及 取值范围: 取值范围-1-99999 默认取值: -1 |
|
timezone |
否 |
String |
参数解释: 用户所在时区,格式形如UTC+08:00 约束限制: 若没有选择年备,月备,周备,日备中任一参数,则不能选择该参数。 取值范围:
... 默认取值: 不涉及 |
|
week_backups |
否 |
Integer |
参数解释: 保留周备个数,该备份不受保留最大备份数限制。若选择该参数,则timezone也必选。 约束限制: 不涉及 取值范围: 取值为0到100。 默认取值: 不涉及 |
|
year_backups |
否 |
Integer |
参数解释: 保留年备个数,该备份不受保留最大备份数限制。若选择该参数,则timezone也必选。 约束限制: 不涉及 取值范围: 取值为0到100。 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
pattern |
是 |
Array of strings |
参数解释: 调度规则。若开启勒索防护时开启备份功能,则该字段必选。 约束限制: 限制24条规则。 取值范围: 调度器的调度规则,可参照iCalendar RFC 2445规范中的事件规则,但仅支持FREQ、BYDAY、BYHOUR、BYMINUTE、INTERVAL等参数,其中FREQ仅支持WEEKLY和DAILY,BYDAY支持一周七天(MO、TU、WE、TH、FR、SA、SU),BYHOUR支持0-23小时,BYMINUTE支持0-59分钟,并且间隔不能小于一小时,一天最大24个时间点。例如,周一到周天,每天14:00调度,其规则为:'FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00'。每天14:00调度,其规则为'FREQ=DAILY;INTERVAL=1;BYHOUR=14;BYMINUTE=00'。 默认取值: 不涉及 |
响应参数
状态码:200
请求已成功
无
请求示例
修改备份策略,目标备份策略ID为af4d08ad-2b60-4916-a5cf-8d6a23956dda。
PUT https://{endpoint}/v5/{project_id}/backup/policy
{
"enabled" : true,
"policy_id" : "af4d08ad-2b60-4916-a5cf-8d6a23956dda",
"operation_definition" : {
"day_backups" : 0,
"max_backups" : -1,
"month_backups" : 0,
"retention_duration_days" : 5,
"timezone" : "UTC+08:00",
"week_backups" : 0,
"year_backups" : 0
},
"trigger" : {
"properties" : {
"pattern" : [ "FREQ=DAILY;INTERVAL=2;BYHOUR=14;BYMINUTE=00" ]
}
}
}
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。