华为云用户手册

响应示例 状态码：200 OK { "agent" : { "created_at" : "2022-01-30T09:28:09.334+00:00", "updated_at" : "2022-01-30T09:28:09.334+00:00", "agent_id" : "489654f2-363b-4ebf-966a-bdf079d97114", "agent_version" : "1.0.0", "agent_type" : "native", "host_name" : "ecs-0001", "host_nickname" : "", "host_ip" : "192.168.10.144", "host_os" : "linux", "status" : "normal", "last_active_time" : "2022-01-30T09:28:08.960+00:00", "paths" : [ { "id" : "5684b0fb-44c8-4c70-bb59-b03ec2738360", "agent_id" : "0cba3ff9-f836-4178-9ce8-91dc8026321c", "dir_path" : "/opt/huaweicloud/cbragent/lib", "status" : "available", "exclude_paths" : "*.txt,/opt/huaweicloud/cbragent/lib/test" }, { "id" : "1ad949d5-c955-4995-8c28-60fc8b110a21", "agent_id" : "0cba3ff9-f836-4178-9ce8-91dc8026321c", "dir_path" : "/opt/backup", "status" : "available", "exclude_paths" : "*.txt,/opt/huaweicloud/cbragent/lib/test" } ] } }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 agent Agent object 客户端详情 表4 Agent 参数 参数类型 描述 created_at String 客户端创建时间 updated_at String 客户端更新时间 agent_id String 客户端ID agent_version String 客户端版本号 agent_type String 客户端类型 host_name String 客户端所在的主机名 host_nickname String 客户端所在的主机昵称 host_ip String 客户端所在主机的IP host_os String 客户端主机所在的操作系统 status String 客户端状态 last_active_time String 客户端上次激活时间 paths Array of Path objects 客户端的备份路径 表5 Path 参数 参数类型 描述 id String 路径ID status String 路径状态，有available和remove两种状态 agent_id String 该路径所属于的客户端ID dir_path String 路径详情 exclude_paths String 排除目录列表，多个路径之间以英文逗号分隔。 说明： 该特性目前处于公测阶段,部分region可能无法使用。

请求示例 创建组织策略。 POST https://{endpoint}/v3/{project_id}/organization-policies { "policy" : { "policy_enabled" : false, "policy_name" : "policy_create_test", "policy_operation_definition" : { "retention_duration_days" : 30, "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" ] } }, "operation_type" : "backup", "name" : "organization-policies_create_test", "description" : "", "effective_scope" : "o-dgit8w537q7np40f9i22j9ieotkuxbjq" } }

响应示例 状态码：200 OK { "policy" : { "id" : "5f5dd325-d7d1-4693-9d97-db37ecb91696", "name" : "organization-policies_create_test", "description" : "", "operation_type" : "backup", "domain_id" : "0ae13f008700d53f0fb4c01200e79660", "policy_name" : "policy_create_test", "policy_operation_definition" : { "max_backups" : -1, "retention_duration_days" : 30, "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" ] } }, "status" : "syncing", "effective_scope" : "o-dgit8w537q7np40f9i22j9ieotkuxbjq" } }

响应参数 状态码：200 表8 响应Body参数 参数 参数类型 描述 policy OrganizationPolicy object 组织策略详情 表9 OrganizationPolicy 参数 参数类型 描述 id String 组织策略ID name String 组织策略名称 description String 组织策略描述 operation_type String 组织策略类型 backup: 备份 replication: 复制 domain_id String 组织策略所属账号ID policy_name String 策略名称 policy_enabled Boolean 策略是否开启 policy_operation_definition PolicyoODCreate object 策略定义，备份和复制里面的具体字段各不相同，和策略的保持一致 policy_trigger PolicyTriggerReq object 策略执行时间规则 status String 组织策略状态 domain_name String 组织策略所属账号 effective_scope String 组织策略生效范围 表10 PolicyoODCreate 参数 参数类型 描述 day_backups Integer 保留日备个数，该备份不受保留最大备份数限制。取值为0到100。如果选择该参数，则timezone 也必选。该字段与retention_duration_days字段不能同时设置。 destination_project_id String 复制的目标项目ID，仅在跨区域复制时才会使用并且必须指定。 destination_region String 复制的目标区域，仅在跨区域复制时才会使用并且必须指定。目标区域不能与当前区域相同。长度限制：0- 255，只能由字母、数字、“_”、“-”组成 enable_acceleration Boolean 跨区域复制时，是否启用加速从而缩减复制的时间，如果不指定，默认不启用加速。 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 表11 PolicyTriggerReq 参数 参数类型 描述 properties PolicyTriggerPropertiesReq object 调度器属性 表12 PolicyTriggerPropertiesReq 参数 参数类型 描述 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'。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 policy 是 OrganizationPolicyCreate object 表4 OrganizationPolicyCreate 参数 是否必选 参数类型 描述 name 是 String 组织策略名称 description 否 String 组织策略描述 operation_type 是 String 组织策略类型 backup: 备份 replication: 复制 policy_name 是 String 策略名称 policy_enabled 是 Boolean 策略是否开启 policy_operation_definition 是 PolicyoODCreate object 策略定义，备份和复制里面的具体字段各不相同，和策略的保持一致 policy_trigger 是 PolicyTriggerReq object 策略执行时间规则 effective_scope 否 String 组织策略生效范围 表5 PolicyoODCreate 参数 是否必选 参数类型 描述 day_backups 否 Integer 保留日备个数，该备份不受保留最大备份数限制。取值为0到100。如果选择该参数，则timezone 也必选。该字段与retention_duration_days字段不能同时设置。 destination_project_id 否 String 复制的目标项目ID，仅在跨区域复制时才会使用并且必须指定。 destination_region 否 String 复制的目标区域，仅在跨区域复制时才会使用并且必须指定。目标区域不能与当前区域相同。长度限制：0- 255，只能由字母、数字、“_”、“-”组成 enable_acceleration 否 Boolean 跨区域复制时，是否启用加速从而缩减复制的时间，如果不指定，默认不启用加速。 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 表6 PolicyTriggerReq 参数 是否必选 参数类型 描述 properties 是 PolicyTriggerPropertiesReq object 调度器属性 表7 PolicyTriggerPropertiesReq 参数 是否必选 参数类型 描述 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'。

响应示例 状态码：200 OK { "total_count" : 7, "resources" : [ { "resource_id" : "e54f7854-8de8-4f98-acf1-65f330bfe877", "resource_name" : "vault-7698-api-test", "resource_detail" : { "vault" : { "id" : "e54f7854-8de8-4f98-acf1-65f330bfe877", "name" : "vault-7698-api-test", "resources" : [ ], "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66", "created_at" : "2023-04-21T08:20:43.022+00:00", "project_id" : "667230ba418f48f1996329f174693053", "enterprise_project_id" : 0, "auto_bind" : false, "bind_rules" : { }, "auto_expand" : false, "smn_notify" : true, "threshold" : 80, "user_id" : "0ae13f012b80d2d81f11c0129285d34b", "billing" : { "allocated" : 0, "cloud_type" : "public", "consistent_level" : "crash_consistent", "charging_mode" : "pre_paid", "order_id" : " CS 23042116192E6CZ", "product_id" : "00301-231151-0--0", "protect_type" : "backup", "object_type" : "server", "spec_code" : "vault.backup.server.normal", "used" : 0, "status" : "available", "size" : 100 }, "tags" : [ ] } }, "tags" : [ ] } ] }

请求参数 表3 请求Body参数 参数 是否必选 参数类型 描述 without_any_tag 否 Boolean 不包含任意一个标签，该字段为true时查询所有不带标签的资源，此时忽略 “tags”、“tags_any”、“not_tags”、“not_tags_any”字段。 tags 否 Array of TagsReq objects 包含标签。 tags不允许为空列表。 tags中最多包含10个key。 tags中key不允许重复。 tags中多个key之间是“与”的关系。 结果返回包含所有标签的资源列表，key之间是与的关系，key-value结构中value是或的关系。 无过滤条件时返回全量数据。 tags_any 否 Array of TagsReq objects 包含任一标签。 tags不允许为空列表。 tags中最多包含10个key。 tags中key不允许重复。 结果返回包含任一标签的资源列表，key之间是或的关系，key-value结构中value是或的关系。 无过滤条件时返回全量数据。 not_tags 否 Array of TagsReq objects 不包含标签。 tags不允许为空列表。 tags中最多包含10个key。 tags中key不允许重复。 结果返回不包含所有标签的资源列表，key之间是与的关系，key-value结构中value是或的关系。 无过滤条件时返回全量数据。 not_tags_any 否 Array of TagsReq objects 不包含任一标签。 tags不允许为空列表。 tags中最多包含10个key。 tags中key不允许重复。 结果返回不包含任一标签的资源列表，key之间是或的关系，key-value结构张value是或的关系。 无过滤条件时返回全量数据。 sys_tags 否 Array of SysTags objects 仅op_service权限可以使用此字段做资源实例过滤条件。 目前TMS调用时只包含一个tag结构体。 key： _sys_enterprise_project_id values：企业项目id列表 目前TMS调用时，key下面只包含一个value，0表示默认企业项目。 sys_tags和租户标签过滤条件（tags、tags_any、not_tags、not_tags_any）不能同时使用。 无sys_tags时按照tag接口处理，无tag过滤条件时返回全量数据。 sys_tags不能为空列表 limit 否 String 查询记录数（action为count时无此参数）如果action为filter时，默认为1000，limit最小值为1，limit最大值为1000, 不在范围内报错。返回的结果中记录数不超过limit。 offset 否 String 索引位置（action为count时无此参数）如果action为filter时，默认为0，offset最小值为0。返回的结果中第一条记录为符合查询条件的第offset+1条记录。 action 是 String 操作标识取值范围为："filter", "count"。如果是filter就是分页查询，如果是count只需按照条件将总条数返回即可 matches 否 Array of Match objects 资源本身支持的查询条件。 matches中key不允许重复。 数组长度最大值为 1，后续再扩展。 cloud_type 否 String 云类型 public: 公有云 hybrid: 混合云 object_type 否 String 资源类型 server: 云服务器 disk: 云硬盘 表4 TagsReq 参数 是否必选 参数类型 描述 key 是 String 键。 最大长度127个unicode字符。 不允许为空字符串。 前后的空格会被丢弃。 values 是 Array of strings 值列表。 values中最多包含10个value。 每个value最大长度255个unicode字符。前后的空格会被丢弃。 values中value不允许重复。 values中多个value之间是"或"的关系。 values允许为空列表，value允许为空字符串。 values如果为空列表，表示任意值。 *为系统保留字符，如果value是以*开头表示按照*后面的值全模糊匹配，不能只传入“*”。 表5 SysTags 参数 是否必选 参数类型 描述 key 是 String 键。 系统标签的key，从白名单中取，不能随意定义。 目前仅支持 _sys_enterprise_project_id字段，对应 的value为企业项目ID。 values 是 Array of strings 值列表。 目前仅会用到企业项目ID，其中默 认的企业项目ID为“0”。 表6 Match 参数 是否必选 参数类型 描述 key 是 String 键。 key取值范围为："resource_name"，资源名称 value 是 String 值。 最大长度255个字符。 key为"resource_name"时，value为空字符串时精确匹配，为非空字符串时模糊匹配。

URI DELETE /v3/{project_id}/vault/{vault_id}/tags/{key} 表1 路径参数 参数 是否必选 参数类型 描述 key 是 String 不能为空或空字符串，不检查长度和字符集，去掉key前后的空格后检查，去掉key前后的空格后使用。 即使底层存在非法的tag也要能删。 project_id 是 String 项目id vault_id 是 String 资源id

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 policy OrganizationPolicy object 组织策略详情 表4 OrganizationPolicy 参数 参数类型 描述 id String 组织策略ID name String 组织策略名称 description String 组织策略描述 operation_type String 组织策略类型 backup: 备份 replication: 复制 domain_id String 组织策略所属账号ID policy_name String 策略名称 policy_enabled Boolean 策略是否开启 policy_operation_definition PolicyoODCreate object 策略定义，备份和复制里面的具体字段各不相同，和策略的保持一致 policy_trigger PolicyTriggerReq object 策略执行时间规则 status String 组织策略状态 domain_name String 组织策略所属账号 effective_scope String 组织策略生效范围 表5 PolicyoODCreate 参数 参数类型 描述 day_backups Integer 保留日备个数，该备份不受保留最大备份数限制。取值为0到100。如果选择该参数，则timezone 也必选。该字段与retention_duration_days字段不能同时设置。 destination_project_id String 复制的目标项目ID，仅在跨区域复制时才会使用并且必须指定。 destination_region String 复制的目标区域，仅在跨区域复制时才会使用并且必须指定。目标区域不能与当前区域相同。长度限制：0- 255，只能由字母、数字、“_”、“-”组成 enable_acceleration Boolean 跨区域复制时，是否启用加速从而缩减复制的时间，如果不指定，默认不启用加速。 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 表6 PolicyTriggerReq 参数 参数类型 描述 properties PolicyTriggerPropertiesReq object 调度器属性 表7 PolicyTriggerPropertiesReq 参数 参数类型 描述 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'。

响应示例 状态码：200 OK { "policy" : { "id" : "5f5dd325-d7d1-4693-9d97-db37ecb91696", "name" : "organization-policies_create_test", "operation_type" : "backup", "domain_id" : "0ae13f008700d53f0fb4c01200e79660", "policy_name" : "policy_create_test", "policy_operation_definition" : { "max_backups" : -1, "retention_duration_days" : 30, "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" ] } }, "status" : "syncing", "effective_scope" : "o-dgit8w537q7np40f9i22j9ieotkuxbjq" } }

AK/SK认证 AK/SK签名认证方式仅支持消息体大小在12MB以内，12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK（Access Key ID）：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK（Secret Access Key）：私有访问密钥。与访问密钥ID结合使用，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Token可通过调用获取用户Token接口获取。 调用本服务API需要项目级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", //IAM用户名 "password": "********", //IAM用户密码 "domain": { "name": "domainname" //IAM用户所属账号名 } } } }, "scope": { "project": { "name": "xxxxxxxx" //项目名称 } } } } 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFG....”，则调用接口时将“X-Auth-Token: ABCDEFG....”加到请求消息头即可，如下所示。 1 2 3 GET https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证：https://bbs.huaweicloud.com/videos/101333。

响应示例 状态码：200 OK { "policy" : { "name" : "policy001", "associated_vaults" : [ ], "enabled" : true, "trigger" : { "properties" : { "pattern" : [ "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00" ], "start_time" : "2019-05-08T06:57:05.000+00:00" }, "type" : "time", "id" : "d67269a6-5369-42d7-8150-5254bd446328", "name" : "default" }, "operation_definition" : { "max_backups" : 1, "year_backups" : 0, "day_backups" : 0, "month_backups" : 0, "week_backups" : 0, "timezone" : "UTC+08:00" }, "operation_type" : "backup", "id" : "cbb3ce6f-3332-4e7c-b98e-77290d8471ff", "policy_type" : "custom_policy" } }

请求示例 修改一个备份策略，周一到周天每天14:00执行备份，保留策略按备份保留时长，保留一天。 PUT https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/policies/cbb3ce6f-3332-4e7c-b98e-77290d8471ff { "policy" : { "enabled" : true, "name" : "policy001", "operation_definition" : { "day_backups" : 0, "month_backups" : 0, "max_backups" : 1, "timezone" : "UTC+08:00", "week_backups" : 0, "year_backups" : 0 }, "trigger" : { "properties" : { "pattern" : [ "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00" ] } } } }

响应参数 状态码：200 表8 响应Body参数 参数 参数类型 描述 policy Policy object 创建响应 表9 Policy 参数 参数类型 描述 enabled Boolean 策略是否启用 id String 策略ID name String 策略名称 operation_definition PolicyoODCreate object 策略属性 operation_type String 保护类型：备份（backup）、复制(replication)。 trigger PolicyTriggerResp object 策略时间调度规则 associated_vaults Array of PolicyAssociateVault objects 关联的存储库 policy_type String 策略类型 表10 PolicyoODCreate 参数 参数类型 描述 day_backups Integer 保留日备个数，该备份不受保留最大备份数限制。取值为0到100。如果选择该参数，则timezone 也必选。该字段与retention_duration_days字段不能同时设置。 destination_project_id String 复制的目标项目ID，仅在跨区域复制时才会使用并且必须指定。 destination_region String 复制的目标区域，仅在跨区域复制时才会使用并且必须指定。目标区域不能与当前区域相同。长度限制：0- 255，只能由字母、数字、“_”、“-”组成 enable_acceleration Boolean 跨区域复制时，是否启用加速从而缩减复制的时间，如果不指定，默认不启用加速。 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 表11 PolicyTriggerResp 参数 参数类型 描述 id String 调度器id name String 调度器名称 properties PolicyTriggerPropertiesResp object 调度器属性 type String 调度器类型,目前只支持 time: 定时调度。 表12 PolicyTriggerPropertiesResp 参数 参数类型 描述 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_time String 调度器开始时间，例如："2020-01-08 09:59:49" 表13 PolicyAssociateVault 参数 参数类型 描述 destination_vault_id String 关联的远端存储库ID vault_id String 存储库ID

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 policy 是 PolicyUpdate object 修改策略body 表4 PolicyUpdate 参数 是否必选 参数类型 描述 enabled 否 Boolean 是否启用策略 name 否 String 策略名称 operation_definition 否 PolicyoODCreate object 调度参数 trigger 否 PolicyTriggerReq object 策略执行时间规则 表5 PolicyoODCreate 参数 是否必选 参数类型 描述 day_backups 否 Integer 保留日备个数，该备份不受保留最大备份数限制。取值为0到100。如果选择该参数，则timezone 也必选。该字段与retention_duration_days字段不能同时设置。 destination_project_id 否 String 复制的目标项目ID，仅在跨区域复制时才会使用并且必须指定。 destination_region 否 String 复制的目标区域，仅在跨区域复制时才会使用并且必须指定。目标区域不能与当前区域相同。长度限制：0- 255，只能由字母、数字、“_”、“-”组成 enable_acceleration 否 Boolean 跨区域复制时，是否启用加速从而缩减复制的时间，如果不指定，默认不启用加速。 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 表6 PolicyTriggerReq 参数 是否必选 参数类型 描述 properties 是 PolicyTriggerPropertiesReq object 调度器属性 表7 PolicyTriggerPropertiesReq 参数 是否必选 参数类型 描述 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'。

请求示例 按需存储库转包周期 https://{endpoint}/v3/{project_id}/orders/change-to-period { "vault_ids" : [ "9dd8f8db-a926-440b-9af5-81b643618898" ], "charging_mode" : "pre_paid", "period_type" : "year", "period_num" : 2, "is_auto_renew" : true, "is_auto_pay" : true, "console_url" : "https://www.{endpoint}/v3/" }

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 charging_mode 否 String 付费模式，当前仅可选择：pre_paid period_type 是 String 创建类型，按年(year)或者按月(month) period_num 是 Integer 创建类型的数量，按年或按月的个数 is_auto_renew 否 Boolean 到期后是否自动续期，默认不续期 is_auto_pay 否 Boolean 是否自动付费，默认为不自动付费 console_url 否 String 跳转URL vault_ids 是 Array of strings 资源列表

URI GET /v3/{project_id}/protectables/{protectable_type}/instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID protectable_type 是 String 对象类型 server： 云服务器类型 disk：云硬盘类型 turbo：turbo类型 workspace：workspace类型 workspace_v2：workspace_v2类型 表2 Query参数 参数 是否必选 参数类型 描述 id 否 String 根据资源id过滤 limit 否 Integer 每页显示的条目数量，每页最多支持50条 marker 否 String 上一次查询最后一条的ID name 否 String 按名称过滤 offset 否 Integer 偏移值 server_id 否 String 根据该id过滤属于该服务器的所有磁盘，支持企业多项目的用户才能传入此参数 status 否 String 资源的状态，如available，error 等 enterprise_project_id 否 String 企业项目ID

响应示例 状态码：200 OK { "instances" : [ { "status" : "ACTIVE", "children" : [ { "status" : "in-use", "name" : "no_delete_for_cbr_interface-volume-0000", "detail" : { "attachments" : [ { "server_id" : "55ecd8b8-1457-4a2a-a9df-53756a690082", "attachment_id" : "e16631fa-0522-4ac8-8f78-19db435caf68", "volume_id" : "13eb535f-8635-4faf-9f08-584d21e78f0a", "attached_at" : "2019-05-08T06:55:26.564+00:00", "device" : "/dev/vda", "id" : "13eb535f-8635-4faf-9f08-584d21e78f0a" } ], "links" : [ { "href" : "https://volume.region1.com/v2/3aec9116a6a5487ca14987121d2818fe/volumes/13eb535f-8635-4faf-9f08-584d21e78f0a", "rel" : "self" }, { "href" : "https://volume.region1.com/3aec9116a6a5487ca14987121d2818fe/volumes/13eb535f-8635-4faf-9f08-584d21e78f0a", "rel" : "bookmark" } ], "availability_zone" : "AZ1", "os-vol-host-attr:host" : "AZ1.xxxxxx#kvm_fusionstorage", "encrypted" : false, "updated_at" : "2019-05-08T08:33:07.855+00:00", "replication_status" : "disabled", "id" : "13eb535f-8635-4faf-9f08-584d21e78f0a", "size" : 40, "user_id" : "3204777a731c4ebea330350c04f41b92", "os-vol-tenant-attr:tenant_id" : "3aec9116a6a5487ca14987121d2818fe", "metadata" : { "policy" : "2ecbcffd-08ba-43f7-bf8d-95daba753464", "readonly" : "False", "attached_mode" : "rw" }, "status" : "in-use", "volume_image_metadata" : { "container_format" : "bare", "min_ram" : 0, "__account_code" : "", "__os_bit" : 64, "size" : 2, "__os_version" : "CentOS 7.2 64bit", "__backup_id" : "", "__description" : "", "__support_diskintensive" : "true", "disk_format" : "vhd", "__isregistered" : "true", "__image_size" : 3295645696, "__platform" : "CentOS", "__root_origin" : "file", "__originalimagename" : "703eb90a-a65f-4c72-b4c1-f070a55d068b", "__quick_start" : "true", "image_name" : "CentOS7.2-cloudinit", "image_id" : "703eb90a-a65f-4c72-b4c1-f070a55d068b", "__os_type" : "Linux", "__image_location" : "172.100.45.130:443:pcsimsf8bd00bf6c304d2e8cf4e2beb0aed702:703eb90a-a65f-4c72-b4c1-f070a55d068b", "min_disk" : 40, "__data_origin" : "file,jingxiang:CentOS-7.2-64bit.zvhd2", "__support_kvm" : "true", "virtual_env_type" : "FusionCompute", "__image_source_type" : "uds", "__support_xen" : "true", "checksum" : "99914b932bd37a50b983c5e7c90ae93b", "__imagetype" : "gold", "__productcode" : "" }, "multiattach" : false, "name" : "no_delete_for_cbr_interface-volume-0000", "bootable" : "true", "created_at" : "2019-05-08T06:54:58.478+00:00", "volume_type" : "SATA", "shareable" : false }, "children" : [ ], "type" : "OS::Cinder::Volume", "id" : "13eb535f-8635-4faf-9f08-584d21e78f0a", "size" : 40 }, { "status" : "in-use", "name" : "volume-f926-0001", "detail" : { "attachments" : [ { "server_id" : "55ecd8b8-1457-4a2a-a9df-53756a690082", "attachment_id" : "3b32cb75-bd96-493b-8fb2-13f063c876d5", "volume_id" : "8d3d519f-d409-4be3-8a1f-9f7a5ecb7a99", "attached_at" : "2019-05-08T06:56:25.892+00:00", "device" : "/dev/vdb", "id" : "8d3d519f-d409-4be3-8a1f-9f7a5ecb7a99" } ], "links" : [ { "href" : "https://volume.region1.com/v2/3aec9116a6a5487ca14987121d2818fe/volumes/8d3d519f-d409-4be3-8a1f-9f7a5ecb7a99", "rel" : "self" }, { "href" : "https://volume.region1.com/3aec9116a6a5487ca14987121d2818fe/volumes/8d3d519f-d409-4be3-8a1f-9f7a5ecb7a99", "rel" : "bookmark" } ], "availability_zone" : "AZ1", "os-vol-host-attr:host" : "AZ1.xxxxxx#FusionStorage", "encrypted" : false, "updated_at" : "2019-05-08T06:56:26.207+00:00", "replication_status" : "disabled", "id" : "8d3d519f-d409-4be3-8a1f-9f7a5ecb7a99", "size" : 10, "user_id" : "f3d66502790d4ddaadef5056059ed8f4", "os-vol-tenant-attr:tenant_id" : "3aec9116a6a5487ca14987121d2818fe", "metadata" : { "policy" : "cf3274fc-d23e-4c12-8be7-1e41b3c2faea", "readonly" : "False", "attached_mode" : "rw" }, "status" : "in-use", "multiattach" : false, "name" : "volume-f926-0001", "bootable" : "false", "created_at" : "2019-03-26T09:30:46.784+00:00", "volume_type" : "SATA", "shareable" : false }, "children" : [ ], "type" : "OS::Cinder::Volume", "id" : "8d3d519f-d409-4be3-8a1f-9f7a5ecb7a99", "size" : 10 } ], "protectable" : { "reason" : "", "code" : "", "result" : true }, "name" : "no_delete_for_cbr_interface", "detail" : { "addresses" : { "94b88790-c906-4450-b7c2-1c2b1ea639bf" : [ { "OS-EXT-IPS-MAC:mac_addr" : "fa:16:3e:9b:9d:af", "version" : 4, "OS-EXT-IPS:port_id" : "f22f531a-d38a-480b-b59e-f7e5db0dcdcc", "addr" : "192.168.1.44", "OS-EXT-IPS:type" : "fixed" }, { "OS-EXT-IPS-MAC:mac_addr" : "fa:16:3e:9b:9d:af", "version" : 4, "OS-EXT-IPS:port_id" : "f22f531a-d38a-480b-b59e-f7e5db0dcdcc", "addr" : "100.78.0.199", "OS-EXT-IPS:type" : "floating" } ] }, "OS-EXT-SRV-ATTR:ramdisk_id" : "", "image" : "", "enterprise_project_id" : 0, "updated" : "2019-05-08T06:57:02.000+00:00", "OS-EXT-SRV-ATTR:user_data" : "IyEvYmluL2Jhc2gKZWNobyAncm9vdDokNiQ5c1FaeXIkdnk5N1pGYXg5WUpRTUpPRElGdGdjYnovTUdEZ1dad3E4VTM1dWE4MjQxTmtDTG1GRjJUUm1BdnZSQnNCLy93VER0aFVRNUt0Z1p6dUlrenp2NmQwYTAnIHwgY2hwYXNzd2QgLWU7", "OS-EXT-STS:vm_state" : "active", "OS-EXT-SRV-ATTR:instance_name" : "instance-0004456e", "OS-EXT-SRV-ATTR:root_device_name" : "/dev/vda", "OS-SRV-USG:launched_at" : "2019-05-08T06:55:38.000+00:00", "flavor" : { "vcpus" : 1, "disk" : 0, "ram" : 1024, "id" : "s3.small.1", "name" : "s3.small.1" }, "id" : "55ecd8b8-1457-4a2a-a9df-53756a690082", "security_groups" : [ { "name" : "default" } ], "os-extended-volumes:volumes_attached" : [ { "device" : "/dev/vda", "id" : "13eb535f-8635-4faf-9f08-584d21e78f0a", "delete_on_termination" : false, "bootIndex" : 0 }, { "device" : "/dev/vdb", "id" : "8d3d519f-d409-4be3-8a1f-9f7a5ecb7a99", "delete_on_termination" : false } ], "user_id" : "f3d66502790d4ddaadef5056059ed8f4", "OS-EXT-SRV-ATTR:hostname" : "no-delete-for-cbr-interface", "OS-DCF:diskConfig" : "MANUAL", "accessIPv4" : "", "accessIPv6" : "", "OS-EXT-SRV-ATTR:reservation_id" : "r-kpb5xckf", "progress" : 0, "OS-EXT-STS:power_state" : 1, "OS-EXT-AZ:availability_zone" : "AZ1", "metadata" : { "metering.image_id" : "703eb90a-a65f-4c72-b4c1-f070a55d068b", "metering.imagetype" : "gold", "metering.resourcespeccode" : "s3.small.1.linux", "metering.cloudServiceType" : "sys.service.type.ec2", "virtual_env_type" : "FusionCompute", "image_name" : "CentOS7.2-cloudinit", "metering.resourcetype" : 1, "vpc_id" : "94b88790-c906-4450-b7c2-1c2b1ea639bf", "os_bit" : 64, "cascaded.instance_extrainfo" : "", "os_type" : "Linux", "charging_mode" : 0 }, "status" : "ACTIVE", "sys_tags" : [ { "value" : 0, "key" : "_sys_enterprise_project_id" } ], "os:scheduler_hints" : { }, "hostId" : "179f22cafe6b951921bd6deb3b13a978df620427fb37bbb7c619de98", "OS-EXT-SRV-ATTR:host" : "AZ1.xxxxxx", "description" : "", "tags" : [ ], "OS-EXT-SRV-ATTR:kernel_id" : "", "locked" : false, "OS-EXT-SRV-ATTR:hypervisor_hostname" : "nova003@36", "name" : "no_delete_for_cbr_interface", "OS-EXT-SRV-ATTR:launch_index" : 0, "created" : "2019-05-08T06:55:22.000+00:00", "tenant_id" : "3aec9116a6a5487ca14987121d2818fe", "host_status" : "UP", "config_drive" : "" }, "type" : "OS::Nova::Server", "id" : "55ecd8b8-1457-4a2a-a9df-53756a690082", "size" : 50 } ] }

功能介绍 为指定实例批量添加或删除标签 标签管理服务需要使用该接口批量管理实例的标签。 一个资源上最多有10个标签（支持landingzone的region支持20个）。 此接口为幂等接口： 创建时如果请求体中存在重复key则报错。 创建时，不允许重复key，如果数据库存在就覆盖。 删除时，允许重复key。 删除时，如果删除的标签不存在，默认处理成功,删除时不对标签字符集范围做校验。key长度127个字符，value为255个字符。删除时tags结构体不能缺失，key不能为空，或者空字符串。

请求示例 批量创建tag POST https://{endpoint}/v3/{project_id}/vault/{vault_id}/tags/action { "tags" : [ { "key" : "string", "value" : "string" }, { "key" : "string1", "value" : "string2" } ], "action" : "create" }

请求示例 POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/agents/79bd9daa-884f-4f84-b8fe-235d58cd927d/add-path { "add_path" : [ "/home/hcp", "/opt/workspace/" ], "exclude_path" : [ { "path_name" : "/home/hcp", "exclude_path_name" : [ "/home/hcp/1", "/home/hcp/2" ] }, { "path_name" : "/opt/workspace/", "exclude_path_name" : [ "/opt/workspace/1", "/opt/workspace/2" ] } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 add_path 是 Array of strings 增加备份路径详情 exclude_path 否 Array of ExcludePath objects 增加排除目录。 说明： 该特性目前处于公测阶段，部分region可能无法使用。 表4 ExcludePath 参数 是否必选 参数类型 描述 path_name 否 String 备份目录 exclude_path_name 否 Array of strings 排除目录列表

响应示例 状态码：200 OK { "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" : 30, "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" ] } }, "status" : "syncing", "effective_scope" : "o-dgit8w537q7np40f9i22j9ieotkuxbjq" } }

请求示例 更新组织策略。 PUT https://{endpoint}/v3/{project_id}/organization-policies { "policy" : { "policy_enabled" : false, "policy_name" : "policy_update_test", "policy_operation_definition" : { "retention_duration_days" : 30, "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" ] } }, "name" : "organization-policies_update_test", "description" : "", "effective_scope" : "" } }

响应参数 状态码：200 表8 响应Body参数 参数 参数类型 描述 policy OrganizationPolicy object 组织策略详情 表9 OrganizationPolicy 参数 参数类型 描述 id String 组织策略ID name String 组织策略名称 description String 组织策略描述 operation_type String 组织策略类型 backup: 备份 replication: 复制 domain_id String 组织策略所属账号ID policy_name String 策略名称 policy_enabled Boolean 策略是否开启 policy_operation_definition PolicyoODCreate object 策略定义，备份和复制里面的具体字段各不相同，和策略的保持一致 policy_trigger PolicyTriggerReq object 策略执行时间规则 status String 组织策略状态 domain_name String 组织策略所属账号 effective_scope String 组织策略生效范围 表10 PolicyoODCreate 参数 参数类型 描述 day_backups Integer 保留日备个数，该备份不受保留最大备份数限制。取值为0到100。如果选择该参数，则timezone 也必选。该字段与retention_duration_days字段不能同时设置。 destination_project_id String 复制的目标项目ID，仅在跨区域复制时才会使用并且必须指定。 destination_region String 复制的目标区域，仅在跨区域复制时才会使用并且必须指定。目标区域不能与当前区域相同。长度限制：0- 255，只能由字母、数字、“_”、“-”组成 enable_acceleration Boolean 跨区域复制时，是否启用加速从而缩减复制的时间，如果不指定，默认不启用加速。 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 表11 PolicyTriggerReq 参数 参数类型 描述 properties PolicyTriggerPropertiesReq object 调度器属性 表12 PolicyTriggerPropertiesReq 参数 参数类型 描述 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'。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 policy 是 OrganizationPolicyUpdate object 表4 OrganizationPolicyUpdate 参数 是否必选 参数类型 描述 name 否 String 组织策略名称 description 否 String 组织策略描述 policy_name 否 String 策略名称 policy_enabled 否 Boolean 策略是否开启 policy_operation_definition 否 PolicyoODCreate object 策略定义，备份和复制里面的具体字段各不相同，和策略的保持一致 policy_trigger 否 PolicyTriggerReq object 策略执行时间规则 effective_scope 否 String 组织策略生效范围 表5 PolicyoODCreate 参数 是否必选 参数类型 描述 day_backups 否 Integer 保留日备个数，该备份不受保留最大备份数限制。取值为0到100。如果选择该参数，则timezone 也必选。该字段与retention_duration_days字段不能同时设置。 destination_project_id 否 String 复制的目标项目ID，仅在跨区域复制时才会使用并且必须指定。 destination_region 否 String 复制的目标区域，仅在跨区域复制时才会使用并且必须指定。目标区域不能与当前区域相同。长度限制：0- 255，只能由字母、数字、“_”、“-”组成 enable_acceleration 否 Boolean 跨区域复制时，是否启用加速从而缩减复制的时间，如果不指定，默认不启用加速。 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 表6 PolicyTriggerReq 参数 是否必选 参数类型 描述 properties 是 PolicyTriggerPropertiesReq object 调度器属性 表7 PolicyTriggerPropertiesReq 参数 是否必选 参数类型 描述 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'。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 alarm_data_list Array of AlarmDataVO objects 告警列表。 total_count Integer 消息总数。 表4 AlarmDataVO 参数 参数类型 描述 id Long 告警通知id。 gmt_create String 创建时间。 gmt_create_timestamp Long 创建的时间戳。 region_alarm_event_id Long region中事件的id。 business_name String 应用名称。 app_name String 组件名称。 version_number Integer 版本。 alarm_rule_type String 告警规则类别。 gmt_modify String 修改时间。 process_unit String 处理单元。 region String 区 域名 称。 instance_id Long 实例id。 ip_address String 实例ip地址。 instance_name String 实例名称。 env_id Long 环境id。 business_id Long 应用id。 template_id Long 模板id。 alarm_rule_id Long 告警规则id。 monitor_item_id Long 监控项id。 collector_id Integer 采集器id。 collector_name String 采集器名称。 alarm_rule_name String 告警规则名称。 alarm_rule_expression String 告警表达式。 alarm_first_time String 开始报警时间。 alarm_last_time String 最后一次报警时间。 alarm_level String 告警级别。 restrain_key String 唯一告警标识符。 status String 告警状态。 alarm_source String 告警来源。 alarm_content String 告警内容。 alarm_data_type String 告警数据类型。