# 更新组织策略 - UpdateOrganizationPolicy #### 功能介绍 更新组织策略 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-cbr/cbr_04_0017.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI PUT /v3/{project_id}/organization-policies/{organization_policy_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | organization_policy_id | 是 | String | **参数解释：** 组织策略ID，获取方法可参考[查询组织策略列表](https://support.huaweicloud.com/api-cbr/ListOrganizationPolicies.html)。 **约束限制：** 不涉及 **取值范围：** UUID，形式为32个十六进制数字 **默认取值：** 不涉及 | | project_id | 是 | String | **参数解释：** 项目ID，获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-cbr/cbr_04_0022.html) **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | policy | 是 | [OrganizationPolicyUpdate] object | 更新组织策略请求体 | 表4OrganizationPolicyUpdate | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | **参数解释：** 组织策略名称 **约束限制：** 只能由中文汉字、英文字母、数字以及三种特定符号组成 **取值范围：** 1-64个字符组成的字符串 **默认取值：** 不涉及 | | description | 否 | String | **参数解释：** 组织策略描述 **约束限制：** 禁止字符串中包含左尖括号 \< 和右尖括号 \>，但允许包含其他任何字符（包括空字符串） **取值范围：** 0-255个字符组成的字符串 **默认取值：** 不涉及 | | policy_name | 否 | String | **参数解释：** 策略名称 **约束限制：** 只能由中文汉字、英文字母、数字以及三种特定符号组成 **取值范围：** 1-64个字符组成的字符串 **默认取值：** 不涉及 | | policy_enabled | 否 | Boolean | **参数解释：** 策略是否启用 **约束限制：** 不涉及 **取值范围：** - true：启用策略定时触发任务 - false：不启用策略，定时不会触发任务 **默认取值：** 不涉及 | | policy_operation_definition | 否 | [PolicyoODCreate] object | 策略定义，备份和复制里面的具体字段各不相同，和策略的保持一致 | | policy_trigger | 否 | [PolicyTriggerUpdateReq] object | 策略执行时间规则 | | effective_scope | 否 | String | **参数解释：** 组织策略生效范围 **约束限制：** 不涉及 **取值范围：** 0-255个字符组成的字符串 **默认取值：** 不涉及 | 表5PolicyoODCreate | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | day_backups | 否 | Integer | 保留日备个数，该备份不受保留最大备份数限制。取值为0到100。默认取值不涉及。如果选择该参数，则timezone 也必选。该字段与retention_duration_days字段不能同时设置。 | | destination_project_id | 否 | String | 复制的目标区域项目ID，仅在跨区域复制时才会使用并且必须指定。默认取值不涉及。 获取方法请参见"[获取项目ID](https://support.huaweicloud.com/api-cbr/cbr_04_0022.html)"。 | | destination_region | 否 | String | 复制的目标区域，仅在跨区域复制时才会使用并且必须指定。目标区域不能与当前区域相同。长度限制：0- 255，只能由字母、数字、"_"、"-"组成。默认取值不涉及。 获取方法请参见"[地区和终端节点查询](https://console.huaweicloud.com/apiexplorer/#/endpoint/CBR)"。 | | enable_acceleration | 否 | Boolean | 跨region复制时，是否启用加速从而缩短复制的时间，如果不指定，默认不启用加速。如果启用加速，会额外收取加速的费用。 - true：启用加速复制。 - false：不启用加速复制。 | | max_backups | 否 | Integer | 单个备份对象自动备份的最大备份数。取值为-1或1-99999。默认取值不涉及。-1代表不按备份数清理。如果该字段和retention_duration_days字段同时为空，备份会永久保留。该字段与retention_duration_days字段不能同时设置。 | | month_backups | 否 | Integer | 保留月备个数，该备份不受保留最大备份数限制。取值为0到100。默认取值不涉及。如果选择该参数，则timezone 也必选。该字段与retention_duration_days字段不能同时设置。 | | retention_duration_days | 否 | Integer | 备份保留时长，单位天。最长支持99999天。默认取值不涉及。-1代表不按时间清理。如果该字段和max_backups 参数同时为空，备份会永久保留。该字段与max_backups、day_backups、week_backups、month_backups和year_backups字段不能同时设置。 | | timezone | 否 | String | 用户所在时区，格式形如"UTC+08:00"，默认取值不涉及。如果选择年备，月备，周备，日备中任一参数，则该参数不能为空。 | | week_backups | 否 | Integer | 保留周备个数，该备份不受保留最大备份数限制。取值为0到100。默认取值不涉及。如果选择该参数，则timezone 也必选。该字段与retention_duration_days字段不能同时设置。 | | year_backups | 否 | Integer | 保留年备个数，该备份不受保留最大备份数限制。取值为0到100。默认取值不涉及。如果选择该参数，则timezone 也必选。该字段与retention_duration_days字段不能同时设置。 | | full_backup_interval | 否 | Integer | 每间隔多少次执行一次全量备份，当取值为 -1 时，不执行全量备份。取值范围\[-1, 100\]，默认取值不涉及。 | | advanced_retention_rules | 否 | [PolicyAdvancedRetentionRules] object | 按照时间的高级保留策略 | 表6PolicyAdvancedRetentionRules | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | weekly_retention_rules | 否 | [PolicyWeeklyRetentionRules] object | 周备备份的保留策略 | | monthly_retention_rules | 否 | [PolicyMonthlyRetentionRules] object | 月备备份的保留策略 | | yearly_retention_rules | 否 | [PolicyYearlyRetentionRules] object | 年备备份的保留策略 | 表7PolicyWeeklyRetentionRules | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | days_of_week | 否 | Array of strings | 设置每个星期中的指定天为周备备份 | | retention_duration_periods | 否 | Integer | 周备的保留时间，取值范围为1-5200，以及-1，单位为周，-1代表周备策略不启用 | 表8PolicyMonthlyRetentionRules | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | retention_type | 否 | String | 月备规则的类型 | | retention_weeks | 否 | Array of strings | 将每月第几个星期的备份设置为月备备份，当retention_type为Weekly时才能设置，设置时需要与days_of_week共同设置 | | days_of_week | 否 | Array of strings | 设置选中的星期中的指定天的备份为月备备份，当retention_type为Weekly时才能设置，设置时需要与retention_weeks共同设置 | | days_of_month | 否 | Array of integers | 表示将每个月中的指定天设置为月备备份，当retention_type为Monthly时才能设置，取值范围为1-28和-1，-1代表每个月的最后一天 | | retention_duration_periods | 否 | Integer | 月备备份的保留时间，取值范围为1-1200，以及-1，单位为月，-1代表月备策略不启用 | 表9PolicyYearlyRetentionRules | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | retention_type | 否 | String | 年备规则的类型 | | retention_months | 否 | Array of strings | 将每年中指定月份的备份设置为年备备份，当retention_type为Weekly时，需要与retention_weeks和days_of_week共同设置，当retention_type为Monthly时，需要与days_of_month共同设置 | | retention_weeks | 否 | Array of strings | 将选中月份的第几个星期的备份设置为年备备份，当retention_type为Weekly时才能设置，设置时需要与retention_months和days_of_week共同设置 | | days_of_month | 否 | Array of integers | 表示将选中月份的指定天的备份设置为年备备份，当retention_type为Monthly时才能设置，取值范围为1-28和-1，-1代表每个月的最后一天，需要与retention_months共同设置 | | days_of_week | 否 | Array of strings | 设置指定月份的指定星期中的指定天的备份为年备备份，当retention_type为Weekly时才能设置，设置时需要与retention_weeks和retention_months共同设置 | | retention_duration_periods | 否 | Integer | 年备备份的保留时间，取值范围为1-100，以及-1，单位为年，-1代表年备策略不启用 | 表10PolicyTriggerUpdateReq | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | properties | 是 | [PolicyTriggerPropertiesUpdateReq] object | 策略调度器修改属性 | 表11PolicyTriggerPropertiesUpdateReq | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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个时间点。例如，周一到周天，每天UTC时间的14:00调度，其规则为：'FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00'。例如：某个地区的时间为 UTC+8，如果在该地区每天14:00调度，则在14点基础上减8，其规则为'FREQ=DAILY;INTERVAL=1;BYHOUR=6;BYMINUTE=00'。默认取值不涉及。 | | start_window_minutes | 否 | Integer | 启动时间窗口大小，取值范围\[60,480\]或者为null。其中null表示取消设置启动时间窗口特性。 | #### 响应参数 **状态码：200** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | policy | [OrganizationPolicy] object | 组织策略详情 | 表13OrganizationPolicy | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 组织策略ID，获取方法可参考[查询组织策略列表](https://support.huaweicloud.com/api-cbr/ListOrganizationPolicies.html) **取值范围：** UUID，形式为32个十六进制数字 | | name | String | **参数解释：** 组织策略名称 **取值范围：** 1-64个字符组成的字符串 | | description | String | **参数解释：** 组织策略描述 **取值范围：** 0-255个字符组成的字符串 | | operation_type | String | **参数解释：** 组织策略类型 **取值范围：** - backup: 备份 - replication: 复制 | | domain_id | String | **参数解释：** 组织策略所属账号ID **取值范围：** 不涉及 | | policy_name | String | **参数解释：** 策略名称 **取值范围：** 1-64个字符组成的字符串 | | policy_enabled | Boolean | **参数解释：** 策略是否启用 **取值范围：** - true：启用策略定时触发任务 - false：不启用策略，定时不会触发任务 | | policy_operation_definition | [PolicyoODCreate] object | 策略定义，备份和复制里面的具体字段各不相同，和策略的保持一致 | | policy_trigger | [PolicyTriggerReq] object | 策略执行时间规则 | | status | String | 组织策略状态，有updating,deleting和available三种状态 updating：更新中，表示目前组织状态策略正在更新。 deleting：删除中，表示目前组织策略正在被删除。 available：可用状态，表示目前没有对组织策略的操作，可以正常使用。 | | domain_name | String | **参数解释：** 组织策略所属账号 **取值范围：** 不涉及 | | effective_scope | String | **参数解释：** 组织策略生效范围 **取值范围：** 0-255个字符组成的字符串 | 表14PolicyoODCreate | 参数 | 参数类型 | 描述 | |:---|:---|:---| | day_backups | Integer | 保留日备个数，该备份不受保留最大备份数限制。取值为0到100。默认取值不涉及。如果选择该参数，则timezone 也必选。该字段与retention_duration_days字段不能同时设置。 | | destination_project_id | String | 复制的目标区域项目ID，仅在跨区域复制时才会使用并且必须指定。默认取值不涉及。 获取方法请参见"[获取项目ID](https://support.huaweicloud.com/api-cbr/cbr_04_0022.html)"。 | | destination_region | String | 复制的目标区域，仅在跨区域复制时才会使用并且必须指定。目标区域不能与当前区域相同。长度限制：0- 255，只能由字母、数字、"_"、"-"组成。默认取值不涉及。 获取方法请参见"[地区和终端节点查询](https://console.huaweicloud.com/apiexplorer/#/endpoint/CBR)"。 | | enable_acceleration | Boolean | 跨region复制时，是否启用加速从而缩短复制的时间，如果不指定，默认不启用加速。如果启用加速，会额外收取加速的费用。 - true：启用加速复制。 - false：不启用加速复制。 | | max_backups | Integer | 单个备份对象自动备份的最大备份数。取值为-1或1-99999。默认取值不涉及。-1代表不按备份数清理。如果该字段和retention_duration_days字段同时为空，备份会永久保留。该字段与retention_duration_days字段不能同时设置。 | | month_backups | Integer | 保留月备个数，该备份不受保留最大备份数限制。取值为0到100。默认取值不涉及。如果选择该参数，则timezone 也必选。该字段与retention_duration_days字段不能同时设置。 | | retention_duration_days | Integer | 备份保留时长，单位天。最长支持99999天。默认取值不涉及。-1代表不按时间清理。如果该字段和max_backups 参数同时为空，备份会永久保留。该字段与max_backups、day_backups、week_backups、month_backups和year_backups字段不能同时设置。 | | timezone | String | 用户所在时区，格式形如"UTC+08:00"，默认取值不涉及。如果选择年备，月备，周备，日备中任一参数，则该参数不能为空。 | | week_backups | Integer | 保留周备个数，该备份不受保留最大备份数限制。取值为0到100。默认取值不涉及。如果选择该参数，则timezone 也必选。该字段与retention_duration_days字段不能同时设置。 | | year_backups | Integer | 保留年备个数，该备份不受保留最大备份数限制。取值为0到100。默认取值不涉及。如果选择该参数，则timezone 也必选。该字段与retention_duration_days字段不能同时设置。 | | full_backup_interval | Integer | 每间隔多少次执行一次全量备份，当取值为 -1 时，不执行全量备份。取值范围\[-1, 100\]，默认取值不涉及。 | | advanced_retention_rules | [PolicyAdvancedRetentionRules] object | 按照时间的高级保留策略 | 表15PolicyAdvancedRetentionRules | 参数 | 参数类型 | 描述 | |:---|:---|:---| | weekly_retention_rules | [PolicyWeeklyRetentionRules] object | 周备备份的保留策略 | | monthly_retention_rules | [PolicyMonthlyRetentionRules] object | 月备备份的保留策略 | | yearly_retention_rules | [PolicyYearlyRetentionRules] object | 年备备份的保留策略 | 表16PolicyWeeklyRetentionRules | 参数 | 参数类型 | 描述 | |:---|:---|:---| | days_of_week | Array of strings | 设置每个星期中的指定天为周备备份 | | retention_duration_periods | Integer | 周备的保留时间，取值范围为1-5200，以及-1，单位为周，-1代表周备策略不启用 | 表17PolicyMonthlyRetentionRules | 参数 | 参数类型 | 描述 | |:---|:---|:---| | retention_type | String | 月备规则的类型 | | retention_weeks | Array of strings | 将每月第几个星期的备份设置为月备备份，当retention_type为Weekly时才能设置，设置时需要与days_of_week共同设置 | | days_of_week | Array of strings | 设置选中的星期中的指定天的备份为月备备份，当retention_type为Weekly时才能设置，设置时需要与retention_weeks共同设置 | | days_of_month | Array of integers | 表示将每个月中的指定天设置为月备备份，当retention_type为Monthly时才能设置，取值范围为1-28和-1，-1代表每个月的最后一天 | | retention_duration_periods | Integer | 月备备份的保留时间，取值范围为1-1200，以及-1，单位为月，-1代表月备策略不启用 | 表18PolicyYearlyRetentionRules | 参数 | 参数类型 | 描述 | |:---|:---|:---| | retention_type | String | 年备规则的类型 | | retention_months | Array of strings | 将每年中指定月份的备份设置为年备备份，当retention_type为Weekly时，需要与retention_weeks和days_of_week共同设置，当retention_type为Monthly时，需要与days_of_month共同设置 | | retention_weeks | Array of strings | 将选中月份的第几个星期的备份设置为年备备份，当retention_type为Weekly时才能设置，设置时需要与retention_months和days_of_week共同设置 | | days_of_month | Array of integers | 表示将选中月份的指定天的备份设置为年备备份，当retention_type为Monthly时才能设置，取值范围为1-28和-1，-1代表每个月的最后一天，需要与retention_months共同设置 | | days_of_week | Array of strings | 设置指定月份的指定星期中的指定天的备份为年备备份，当retention_type为Weekly时才能设置，设置时需要与retention_weeks和retention_months共同设置 | | retention_duration_periods | Integer | 年备备份的保留时间，取值范围为1-100，以及-1，单位为年，-1代表年备策略不启用 | 表19PolicyTriggerReq | 参数 | 参数类型 | 描述 | |:---|:---|:---| | properties | [PolicyTriggerPropertiesReq] object | 策略调度器属性 | 表20PolicyTriggerPropertiesReq | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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个时间点。例如，周一到周天，每天UTC时间的14:00调度，其规则为：'FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00'。例如：某个地区的时间为 UTC+8，如果在该地区每天14:00调度，则在14点基础上减8，其规则为'FREQ=DAILY;INTERVAL=1;BYHOUR=6;BYMINUTE=00'。默认取值不涉及。 | | start_window_minutes | Integer | 启动时间窗口大小 | #### 请求示例 更新组织策略。 ``` PUT https://{endpoint}/v3/{project_id}/organization-policies/{organization_policy_id} { "policy" : { "policy_enabled" : false, "policy_name" : "policy_update_test", "policy_operation_definition" : { "retention_duration_days" : -1, "max_backups" : -1, "day_backups" : 0, "week_backups" : 0, "month_backups" : 0, "year_backups" : 0, "timezone" : "UTC+08:00", "full_backup_interval" : -1 }, "policy_trigger" : { "properties" : { "pattern" : [ "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00" ], "start_window_minutes" : 60 } }, "name" : "organization-policies_update_test", "description" : "", "effective_scope" : "" } } ``` #### 响应示例 **状态码：200** ``` { "policy" : { "id" : "5f5dd325-d7d1-4693-9d97-db37ecb91696", "name" : "organization-policies_update_test", "description" : "", "operation_type" : "backup", "domain_id" : "0ae13f008700d53f0fb4c01200e79660", "policy_name" : "policy_update_test", "policy_operation_definition" : { "max_backups" : -1, "retention_duration_days" : -1, "day_backups" : 0, "week_backups" : 0, "month_backups" : 0, "year_backups" : 0, "timezone" : "UTC+08:00", "full_backup_interval" : -1 }, "policy_enabled" : false, "policy_trigger" : { "properties" : { "pattern" : [ "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00" ], "start_window_minutes" : 60 } }, "status" : "available", "effective_scope" : "o-dgit8w537q7np40f9i22j9ieotkuxbjq" } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-cbr/ErrorCode.html)。