华为云用户手册

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 backup BackupResp object 备份副本 表5 BackupResp 参数 参数类型 描述 checkpoint_id String 还原点ID created_at String 创建时间，例如:"2020-02-05T10:38:34.209782" description String 备份描述 expired_at String 过期时间，例如:"2020-02-05T10:38:34.209782" extend_info BackupExtendInfo object 扩展信息 id String 备份ID image_type String 备份类型。取值为backup和replication。 name String 备份名称 parent_id String 父备份ID project_id String 项目ID protected_at String 备份时间 resource_az String 资源可用区 resource_id String 资源ID resource_name String 资源名称 resource_size Integer 资源大小，单位为GB resource_type String 资源类型: OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo, OS::Workspace::DesktopV2 status String 备份状态 available: 可用 protecting: 保护中 deleting: 删除中 restoring: 恢复中 error: 异常 waiting_protect: 等待保护 waiting_delete: 等待删除 waiting_restore: 等待恢复 updated_at String 更新时间，例如:"2020-02-05T10:38:34.209782" vault_id String 存储库ID replication_records Array of ReplicationRecordGet objects 复制记录 enterprise_project_id String 企业项目id,默认为‘0’。 provider_id String 备份提供商ID，用于区分备份对象。当前取值包含： 0daac4c5-6707-4851-97ba-169e36266b66，该值代表备份对象为云服务器。d1603440-187d-4516-af25-121250c7cc97，该值代表备份对象为云硬盘。3f3c3220-245c-4805-b811-758870015881， 该值代表备份对象为SFS Turbo。a13639de-00be-4e94-af30-26912d75e4a2，该值代表备份对象为混合云VMware备份。 children Array of BackupResp objects 子副本列表 incremental Boolean 是否是增备 表6 BackupExtendInfo 参数 参数类型 描述 auto_trigger Boolean 是否是自动生成的备份副本 bootable Boolean 是否系统盘备份 snapshot_id String 卷备份副本的快照id support_lld Boolean 是否支持lazyloading快速恢复 supported_restore_mode String 备份支持恢复的方式 na: 备份不支持直接恢复，只支持备份创建新资源等操作。 backup: 备份支持通过云服务器上硬盘的备份进行恢复。 snapshot: 备份此时已经支持创建整机镜像。 缺省值：na os_images_data Array of ImageData objects 备份注册镜像ID列表 contain_system_disk Boolean 整机备份是否包含系统盘 encrypted Boolean 是否加密 system_disk Boolean 是否是系统盘 is_multi_az Boolean 备份类型是否为多AZ 缺省值：false 表7 ImageData 参数 参数类型 描述 image_id String 镜像ID 表8 ReplicationRecordGet 参数 参数类型 描述 created_at String 复制的开始时间 destination_backup_id String 复制的目的备份ID destination_checkpoint_id String 复制的目的备份记录ID destination_project_id String 复制的目标项目ID destination_region String 复制的目标区域 destination_vault_id String 目标存储库ID extra_info ReplicationRecordsExtraInfo object 复制附加信息 id String 复制记录ID source_backup_id String 复制的源备份ID source_checkpoint_id String 复制的源备份记录ID source_project_id String 复制的源项目ID source_region String 复制的源区域 status String 复制的状态 replicating: 复制中 success: 成功 fail: 失败 skip: 跳过 waiting_replicate: 等待复制 vault_id String 备份所在的存储库ID 表9 ReplicationRecordsExtraInfo 参数 参数类型 描述 progress Integer 复制进度 fail_code String 失败错误码，成功时为空 fail_reason String 错误原因 auto_trigger Boolean 是否为自动调度复制 destinatio_vault_id String 目标端的存储库id

响应示例 状态码： 200 OK { "count" : 1, "vaults" : [ { "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66", "name" : "vault-name", "billing" : { "status" : "available", "used" : 5588, "protect_type" : "replication", "object_type" : "server", "consistent_level" : "crash_consistent", "cloud_type" : "public", "allocated" : 0, "charging_mode" : "post_paid", "spec_code" : "vault.replication.server.normal", "size" : 10 }, "tags" : [ ], "created_at" : "2019-04-08T11:06:25.766+00:00", "enterprise_project_id" : "876ae48d-cfb3-4aff-bb55-83167abd3876", "project_id" : "68589cac08274b82b4e254268a3862d8", "id" : "0ca3eb86-8800-46da-9c37-9d657a825274", "resources" : [ ] } ] }

URI GET /v3/{project_id}/vaults/external 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 表2 Query参数 参数 是否必选 参数类型 描述 cloud_type 否 String 云类型。取值为public和hybrid。 external_project_id 是 String 其他区域的项目ID limit 否 Integer 每页显示条目数 最小值：1 最大值：1000 objcet_type 否 String 资源类型 offset 否 Integer 偏移值 protect_type 否 String 保护类型。取值为backup，replication和hybrid。 region_id 是 String 区域ID vault_id 否 String 存储库ID，指定存储ID时其他过滤条件不生效。

请求示例 创建一个备份策略，周一到周天每天14:00执行备份，保留策略按备份保留时长，保留一天。 POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/policies { "policy" : { "enabled" : true, "name" : "policy001", "operation_definition" : { "day_backups" : 0, "month_backups" : 0, "retention_duration_days" : 1, "timezone" : "UTC+08:00", "week_backups" : 0, "year_backups" : 0 }, "operation_type" : "backup", "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 关联的存储库 表10 PolicyoODCreate 参数 参数类型 描述 day_backups Integer 保留日备个数，该备份不受保留最大备份数限制。取值为0到100。如果选择该参数，则timezone 也必选。 最小值：0 最大值：100 destination_project_id String 复制的目标项目ID，仅在跨区域复制时才会使用并且必须指定。 destination_region String 复制的目标区域，仅在跨区域复制时才会使用并且必须指定。长度限制：0- 255，只能由字母、数字、“_”、“-”组成 enable_acceleration Boolean 跨区域复制时，是否启用加速从而缩减复制的时间，如果不指定，默认不启用加速。 max_backups Integer 单个备份对象自动备份的最大备份数。取值为-1或0-99999。-1代表不按备份数清理。如果该字段和retention_duration_days字段同时为空，备份会永久保留。 最小值：1 最大值：99999 缺省值：-1 month_backups Integer 保留月备个数，该备份不受保留最大备份数限制。取值为0到100。如果选择该参数，则timezone 也必选。 最小值：0 最大值：100 retention_duration_days Integer 备份保留时长，单位天。最长支持99999天。-1代表不按时间清理。如果该字段和max_backups 参数同时为空，备份会永久保留。 最小值：1 最大值：99999 缺省值：-1 timezone String 用户所在时区,格式形如UTC+08:00, 如果选择年备，月备，周备，日备中任一参数，则该参数不能为空。 week_backups Integer 保留周备个数，该备份不受保留最大备份数限制。取值为0到100。如果选择该参数，则timezone 也必选。 year_backups Integer 保留年备个数，该备份不受保留最大备份数限制。取值为0到100。如果选择该参数，则timezone 也必选。 最小值：0 最大值：100 full_backup_interval Integer 每间隔多少次执行一次全量备份，当取值为 -1 时，不执行全量备份 最小值：-1 最大值：100 最小值：-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

响应示例 状态码： 200 OK { "policy" : { "name" : "policy001", "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" : { "retention_duration_days" : 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" } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 policy 是 PolicyCreate object 创建策略body 表4 PolicyCreate 参数 是否必选 参数类型 描述 enabled 否 Boolean 是否启用策略 缺省值：true name 是 String 策略名称，长度限制：1- 64，只能由中文、字母、数字、“_”、“-”组成。 最小长度：1 最大长度：64 operation_definition 是 PolicyoODCreate object 调度参数 operation_type 是 String 保护类型：备份（backup）、复制(replication)。 trigger 是 PolicyTriggerReq object 策略执行时间规则 表5 PolicyoODCreate 参数 是否必选 参数类型 描述 day_backups 否 Integer 保留日备个数，该备份不受保留最大备份数限制。取值为0到100。如果选择该参数，则timezone 也必选。 最小值：0 最大值：100 destination_project_id 否 String 复制的目标项目ID，仅在跨区域复制时才会使用并且必须指定。 destination_region 否 String 复制的目标区域，仅在跨区域复制时才会使用并且必须指定。长度限制：0- 255，只能由字母、数字、“_”、“-”组成 enable_acceleration 否 Boolean 跨区域复制时，是否启用加速从而缩减复制的时间，如果不指定，默认不启用加速。 max_backups 否 Integer 单个备份对象自动备份的最大备份数。取值为-1或0-99999。-1代表不按备份数清理。如果该字段和retention_duration_days字段同时为空，备份会永久保留。 最小值：1 最大值：99999 缺省值：-1 month_backups 否 Integer 保留月备个数，该备份不受保留最大备份数限制。取值为0到100。如果选择该参数，则timezone 也必选。 最小值：0 最大值：100 retention_duration_days 否 Integer 备份保留时长，单位天。最长支持99999天。-1代表不按时间清理。如果该字段和max_backups 参数同时为空，备份会永久保留。 最小值：1 最大值：99999 缺省值：-1 timezone 否 String 用户所在时区,格式形如UTC+08:00, 如果选择年备，月备，周备，日备中任一参数，则该参数不能为空。 week_backups 否 Integer 保留周备个数，该备份不受保留最大备份数限制。取值为0到100。如果选择该参数，则timezone 也必选。 year_backups 否 Integer 保留年备个数，该备份不受保留最大备份数限制。取值为0到100。如果选择该参数，则timezone 也必选。 最小值：0 最大值：100 full_backup_interval 否 Integer 每间隔多少次执行一次全量备份，当取值为 -1 时，不执行全量备份 最小值：-1 最大值：100 最小值：-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" : [ ] } ] }

请求参数 表2 请求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，后续再扩展。 数组长度：0 - 1 cloud_type 否 String 云类型 public: 公有云 hybrid: 混合云 object_type 否 String 资源类型 server: 云服务器 disk: 云硬盘 表3 TagsReq 参数 是否必选 参数类型 描述 key 是 String 键。 最大长度127个unicode字符。 不允许为空字符串。 前后的空格会被丢弃。 values 是 Array of strings 值列表。 values中最多包含10个value。 每个value最大长度255个unicode字符。前后的空格会被丢弃。 values中value不允许重复。 values中多个value之间是"或"的关系。 values允许为空列表，value允许为空字符串。 values如果为空列表，表示任意值。 *为系统保留字符，如果value是以*开头表示按照*后面的值全模糊匹配，不能只传入“*”。 表4 SysTags 参数 是否必选 参数类型 描述 key 是 String 键。 系统标签的key，从白名单中取，不能随意定义。 目前仅支持 _sys_enterprise_project_id字段，对应 的value为企业项目ID。 values 是 Array of strings 值列表。 目前仅会用到企业项目ID，其中默 认的企业项目ID为“0”。 表5 Match 参数 是否必选 参数类型 描述 key 是 String 键。 key取值范围为："resource_name"，资源名称 value 是 String 值。 最大长度255个字符。 key为"resource_name"时，value为空字符串时精确匹配，为非空字符串时模糊匹配。

请求示例 PUT https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/backups/a5200268-74a5-4806-acc6-95793ab0228b/members/f841e01fd2b14e7fa41b6ae7aa6b0594 { "status" : "accepted", "vault_id" : "4b27c05b-8ad7-48c6-a886-526666c035f0" }

响应示例 状态码： 200 OK { "member" : { "status" : "accepted", "backup_id" : "17c9acd8-3af3-4401-bab9-ff1cfac15561", "vault_id" : "4b27c05b-8ad7-48c6-a886-526666c035f0", "dest_project_id" : "0761021b8900d2622f38c0115db0b331", "created_at" : "2020-02-24T09:36:00.479+00:00", "id" : "824a90b3-c562-448b-ab04-60ea4a97cf60" } }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 member Member object 查询备份共享成员详情响应信息 表5 Member 参数 参数类型 描述 status String 共享状态 pending: 等待处理 accepted: 已接收 rejected: 已拒绝 created_at String 共享时间，例如:"2020-02-05T10:38:34.209782" updated_at String 更新时间，例如:"2020-02-05T10:38:34.209782" backup_id String 备份副本id image_id String 接受的共享备份副本注册的镜像id dest_project_id String 接受备份共享的项目id vault_id String 目标端接受共享备份的存储库id id String 共享记录id

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 status 是 String 备份共享状态 accepted: 已接收 pending: 处理中 rejected: 已拒绝 vault_id 否 String 共享的备份将存入的存储库，仅支持uuid 更新member状态的时候，如果是接受，必须传入vault_id，如果是拒绝，则无需

操作步骤 创建策略。 接口相关信息 URI格式：POST /v3/{project_id}/policies 详情请参见：创建策略 。 请求示例 POST: https://{endpoint}/v3/0605767b5780d5762fc5c0118072a564/policies {endpoint}信息请从地区和终端节点获取。 Body: { "policy": { "name": "dh_test_policy", "trigger": { "properties": { "pattern": ["FREQ=WEEKLY;BYDAY=SU,MO,TU,WE,TH,FR,SA;BYHOUR=23;BYMINUTE=00"] } }, "operation_definition": { "retention_duration_days": 30 } } } 响应示例 { "policy": { "id": "30d7cf2d-14fc-415b-b7da-858b37f47250", "name": "dh_test_policy", "operation_type": "backup", "operation_definition": { "retention_duration_days": 30 }, "enabled": true, "trigger": { "id": "7954175b-ef2c-432c-b936-f6c83df7a593", "name": "default", "type": "time", "properties": { "pattern": [ "FREQ=WEEKLY;BYDAY=SU,MO,TU,WE,TH,FR,SA;BYHOUR=23;BYMINUTE=00" ], "start_time": "2020-08-17 08:39:44" } }, "associated_vaults": null } } 设置存储库策略。 接口相关信息 POST /v3/{project_id}/vaults/{vault_id}/associatepolicy 详情请参见设置存储库策略。 请求示例 POST: https://{endpoint}/v3/0605767b5780d5762fc5c0118072a564 /vaults/ea7b8717-2543-478a-a92d-3ca7ee448f67/associatepolicy {endpoint}信息请从地区和终端节点获取。 Body: { "policy_id": "30d7cf2d-14fc-415b-b7da-858b37f47250" } 响应示例 { "associate_policy": { "vault_id": "ea7b8717-2543-478a-a92d-3ca7ee448f67", "policy_id": "30d7cf2d-14fc-415b-b7da-858b37f47250" } }

标签 权限 对应API接口 授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 查询存储库资源实例 POST /v3/{project_id}/vault/resource_instances/action cbr:vaults:listResourceInstances √ √ 批量添加删除存储库资源标签 POST /v3/{project_id}/vault/{vault_id}/tags/action cbr:vaults:bulkCreateOrDeleteTags √ √ 添加存储库资源标签 POST /v3/{project_id}/vault/{vault_id}/tags cbr:vaults:setTags √ √ 删除存储库资源标签 DELETE /v3/{project_id}/vault/{vault_id}/tags/{key} cbr:vaults:deleteTags √ √ 查询存储库资源标签 GET /v3/{project_id}/vault/{vault_id}/tags cbr:vaults:getTags √ √ 查询存储库项目标签 GET /v3/{project_id}/vault/tags cbr:vaults:listProjectTags √ √

还原点 权限 对应API接口 授权项 依赖的授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 同步备份还原点 POST /v3/{project_id}/checkpoints/sync cbr:vaults:sync - √ √ 复制备份还原点 POST /v3/{project_id}/checkpoints/replicate cbr:vaults:replicate - √ √ 创建备份还原点 POST /v3/{project_id}/checkpoints cbr:vaults:backup ecs:cloudServers:list evs:volumes:list √ √

策略 权限 对应API接口 授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 查询策略列表 GET /v3/{project_id}/policies cbr:policies:list √ √ 创建策略 POST /v3/{project_id}/policies cbr:policies:create √ √ 查询单个策略 GET /v3/{project_id}/policies/{policy_id} cbr:policies:get √ √ 修改策略 PUT /v3/{project_id}/policies/{policy_id} cbr:policies:update √ √ 删除策略 DELETE /v3/{project_id}/policies/{policy_id} cbr:policies:delete √ √

备份 权限 对应API接口 授权项 依赖的授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 查询所有备份 GET /v3/{project_id}/backups cbr:backups:list - √ √ 查询指定备份 GET /v3/{project_id}/backups/{backup_id} cbr:backups:get - √ √ 删除备份 DELETE /v3/{project_id}/backups/{backup_id} cbr:backups:delete - √ √ 同步备份 POST /v3/{project_id}/backups/sync cbr:backups:sync - √ √ 备份恢复 POST /v3/{project_id}/backups/{backup_id}/restore cbr:backups:restore ecs:cloudServers:list evs:volumes:list √ √ 复制备份 POST /v3/{project_id}/backups/{backup_id}/replicate cbr:backups:replicate - √ √

备份共享 权限 对应API接口 授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 添加备份成员 POST /v3/{project_id}/backups/{backup_id}/members cbr:member:create √ √ 更新备份成员状态 PUT /v3/{project_id}/backups/{backup_id}/members/{member_id} cbr:member:update √ √ 获取备份成员详情 GET /v3/{project_id}/backups/{backup_id}/members/{member_id} cbr:member:get √ √ 获取备份成员列表 GET /v3/{project_id}/backups/{backup_id}/members cbr:member:list √ √ 删除指定的备份成员 DELETE /v3/{project_id}/backups/{backup_id}/members/{member_id} cbr:member:delete √ √

存储库 权限 对应API接口 授权项 依赖的授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 设置存储库策略 POST /v3/{project_id}/vaults/{vault_id}/associatepolicy cbr:vaults:associatePolicy - √ √ 查询指定存储库 GET /v3/{project_id}/vaults/{vault_id} cbr:vaults:get - √ √ 修改存储库 PUT /v3/{project_id}/vaults/{vault_id} cbr:vaults:update - √ √ 删除存储库 DELETE /v3/{project_id}/vaults/{vault_id} cbr:vaults:delete - √ √ 移除资源 POST /v3/{project_id}/vaults/{vault_id}/removeresources cbr:vaults:removeResources - √ √ 添加资源 POST /v3/{project_id}/vaults/{vault_id}/addresources cbr:vaults:addResources ecs:cloudServers:list evs:volumes:list √ √ 查询存储库列表 GET /v3/{project_id}/vaults cbr:vaults:list - √ √ 创建存储库 POST /v3/{project_id}/vaults cbr:vaults:create ecs:cloudServers:list evs:volumes:list √ √ 查询其他区域存储库列表 GET /v3/{project_id}/external_vaults cbr:vaults:listExternalVaults cbr:vaults:listVaults √ √ 解除存储库策略 POST /v3/{project_id}/vaults/{vault_id}/dissociatepolicy cbr:vaults:dissociatePolicy - √ √ 迁移资源 POST /v3/{project_id}/vaults/{vault_id}/migrateresources cbr:vaults:migrateResources cbr:vaults:addResources √ √

任务 权限 对应API接口 授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 查询任务列表 GET /v3/{project_id}/operation-logs cbr:tasks:list √ √ 查询单个任务 GET /v3/{project_id}/operation-logs/{operation_log_id} cbr:tasks:get √ √

可保护性 权限 对应API接口 授权项 依赖的授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 查询可保护资源 GET /v3/{project_id}/protectables/{protectable_type}/instances cbr:vaults:listProtectables ecs:cloudServers:list evs:volumes:list √ √ 查询指定可保护资源 GET /v3/{project_id}/protectables/{protectable_type}/instances/{instance_id} cbr:vaults:getProtectables ecs:cloudServers:list evs:volumes:list √ √ 查询agent状态 POST /v3/{project_id}/agent/check cbr:backups:checkAgent ecs:cloudServers:list √ √ 查询复制能力 GET /v3/{project_id}/replication-capabilities cbr:backups:queryReplicationCapability - √ √

请求示例 设置存储库资源自动备份 PUT https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults/2b076f26-391f-40fa-bf71-a798940faccf/set_resource { "resource_ids" : [ "2b076f26-391f-40fa-bf71-a798940facbb", "dfx76f26-391f-40fa-bf71-a798940facaa" ], "action" : "suspend" }

响应示例 状态码： 200 OK { "checkpoint" : { "status" : "available", "created_at" : "2019-05-10T07:59:12.037+00:00", "vault" : { "id" : "3b5816b5-f29c-4172-9d9a-76c719a659ce", "resources" : [ { "name" : "ecs-1f0f-0002", "resource_size" : 40, "protect_status" : "available", "type" : "OS::Nova::Server", "id" : "94eba8b2-acc9-4d82-badc-127144cc5526" } ], "name" : "vault-be94" }, "project_id" : "4229d7a45436489f8c3dc2b1d35d4987", "id" : "8b0851a8-adf3-4f4c-a914-dead08bf9664" } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 checkpoint CheckpointCreate object 还原点信息 表4 CheckpointCreate 参数 参数类型 描述 created_at String 创建时间，例如:"2020-02-05T10:38:34.209782" id String 还原点ID project_id String 项目ID status String 状态 available: 可用 deleting: 删除中 protecting: 保护中 deleted: 已删除 error-deleting:删除异常 error: 异常 vault CheckpointPlanCreate object 存储库信息 extra_info CheckpointExtraInfoResp object 扩展信息 表5 CheckpointPlanCreate 参数 参数类型 描述 id String 存储库id name String 存储库名称 resources Array of CheckpointResourceResp objects 备份对象 skipped_resources Array of CheckpointCreateSkippedResource objects 备份时跳过的资源列表 表6 CheckpointResourceResp 参数 参数类型 描述 extra_info String 资源附加信息 id String 待备份资源id name String 待备份资源名称 protect_status String 保护状态 available: 可用 error: 异常 protecting: 保护中 restoring: 恢复中 removing: 删除中 resource_size String 资源已分配容量,单位为GB type String 待备份资源的类型: OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo, OS::Workspace::DesktopV2 backup_size String 副本大小 backup_count String 副本数量 表7 CheckpointCreateSkippedResource 参数 参数类型 描述 id String 资源ID type String 资源类型 name String 资源名称 code String 请参见错误码。 reason String 跳过原因，例如：该资源正在备份中。 表8 CheckpointExtraInfoResp 参数 参数类型 描述 name String 备份名称 description String 备份描述 retention_duration Integer 备份保留天数

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值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 1 2 3 POST 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 { "members" : [ { "status" : "pending", "backup_id" : "0b07081e-3ec7-4e77-8571-54e2947da422", "dest_project_id" : "075e6035d300d48c2fd0c00b78b71ebf", "created_at" : "2020-02-05T10:38:34.210+00:00", "id" : "3c5a3015-c3a0-4dc6-a1e2-917b90f62319" } ], "count" : 50 }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 members Array of Member objects 添加备份共享成员响应信息 count Integer 备份共享成员数量 表5 Member 参数 参数类型 描述 status String 共享状态 pending: 等待处理 accepted: 已接收 rejected: 已拒绝 created_at String 共享时间，例如:"2020-02-05T10:38:34.209782" updated_at String 更新时间，例如:"2020-02-05T10:38:34.209782" backup_id String 备份副本id image_id String 接受的共享备份副本注册的镜像id dest_project_id String 接受备份共享的项目id vault_id String 目标端接受共享备份的存储库id id String 共享记录id

支持的授权项 策略包含系统策略和自定义策略，如果系统策略不满足授权要求，管理员可以创建自定义策略，并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应，授权项列表说明如下： 权限：允许或拒绝某项操作。 对应API接口：自定义策略实际调用的API接口。 授权项：自定义策略中支持的Action，在自定义策略中的Action中写入授权项，可以实现授权项对应的权限功能。 依赖的授权项：部分Action存在对其他Action的依赖，需要将依赖的Action同时写入授权项，才能实现对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project)：自定义策略的授权范围，包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目，表示此授权项对应的自定义策略，可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目，不支持企业项目，表示仅能在IAM中给用户组授权并生效，如果在企业管理中授权，则该自定义策略不生效。关于IAM项目与企业项目的区别，详情请参见：IAM与企业管理的区别。 “√”表示支持，“x”表示暂不支持。 CBR的支持自定义策略授权项如下所示： 【示例】存储库，包含CBR所有存储库接口对应的授权项，如创建存储库、查询存储库列表、修改存储库、删除存储库、添加资源、移除资源等接口。 【示例】备份共享，包括CBR备份共享接口对应的授权项，如添加备份成员、获取备份成员列表、更新备份成员状态等接口。