华为云用户手册

请求示例 设置存储库资源自动备份 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备份共享接口对应的授权项，如添加备份成员、获取备份成员列表、更新备份成员状态等接口。

响应示例 状态码： 200 OK { "count" : 2, "backups" : [ { "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66", "checkpoint_id" : "1fced58b-2a31-4851-bcbb-96216f83ce99", "updated_at" : "2020-02-21T07:07:25.114+00:00", "vault_id" : "cca85ea5-00a4-418d-9222-bd83985bc515", "id" : "b1c4afd9-e7a6-4888-9010-c2bac3aa7910", "resource_az" : "br-iaas-odin1a", "image_type" : "backup", "resource_id" : "1a503932-ee8f-4dd5-8248-8dfb57e584c5", "resource_size" : 40, "children" : [ ], "extend_info" : { "auto_trigger" : true, "supported_restore_mode" : "backup", "contain_system_disk" : true, "support_lld" : true, "system_disk" : false }, "project_id" : "0605767b5780d5762fc5c0118072a564", "status" : "available", "resource_name" : "test001-02", "description" : "", "expired_at" : "2020-05-21T07:00:54.060+00:00", "name" : "autobk_b629", "created_at" : "2020-02-21T07:00:54.065+00:00", "resource_type" : "OS::Nova::Server" }, { "provider_id" : "d1603440-187d-4516-af25-121250c7cc97", "checkpoint_id" : "f64c351f-769f-4c04-8806-fd90a59e9b12", "updated_at" : "2020-02-21T07:09:37.767+00:00", "vault_id" : "79bd9daa-884f-4f84-b8fe-235d58cd927d", "id" : "5606aab5-2dc2-4498-8144-dc848d099af5", "resource_az" : "br-iaas-odin1a", "image_type" : "backup", "resource_id" : "54f7ccbc-072f-4ec5-a7b7-b24dabdb4539", "resource_size" : 40, "children" : [ ], "extend_info" : { "auto_trigger" : true, "snapshot_id" : "e3def9a8-e4b4-4c12-b132-f4ba8ce9a34f", "bootable" : true, "support_lld" : true, "encrypted" : false, "system_disk" : false }, "project_id" : "0605767b5780d5762fc5c0118072a564", "status" : "available", "resource_name" : "qsy_000", "description" : "", "expired_at" : "2020-03-22T07:00:34.878+00:00", "name" : "autobk_6809", "created_at" : "2020-02-21T07:00:34.882+00:00", "resource_type" : "OS::Cinder::Volume" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 backups Array of BackupResp objects 备份列表 count Integer 备份个数 offset Integer 偏移量，表示从此偏移量开始查询 最小值：0 缺省值：0 limit Integer 每页显示的条目数量 最小值：1 最大值：1000 缺省值：1000 表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

修订记录 发布日期 修订记录 2023-09-30 第五次正式发布。 本次更新说明如下： 支持多AZ存储。 2022-12-14 第四次正式发布。 本次更新说明如下： 上线 云桌面 备份存储库相关参数。 2020-10-29 第三次正式发布。 本次更新说明如下： 上线tag相关接口。 2020-04-01 第二次正式发布。 本次更新说明如下： 删除基于策略的访问控制公测的相关内容。 2019-08-19 第一次正式发布。

调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目列表API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”，其中{Endpoint}为IAM的终端节点，可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下，其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65ewtrgaggshhk1223245sghjlse684b", "is_domain": false, "parent_id": "65ewtrgaggshhk1223245sghjlse684b", "name": "project_name", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4adasfjljaaaakla12334jklga9sasfg" }, "id": "a4adasfjljaaaakla12334jklga9sasfg", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }

请求示例 创建一个云服务器存储库，存储库容量为100G，按需计费，且同时绑定资源和添加标签。 POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults { "vault" : { "backup_policy_id" : "6dd81d7d-a4cb-443e-b8ed-1af0bd3a261b", "billing" : { "cloud_type" : "public", "consistent_level" : "crash_consistent", "object_type" : "server", "protect_type" : "backup", "size" : 100, "charging_mode" : "post_paid", "is_auto_renew" : false, "is_auto_pay" : false, "console_url" : "https://console.demo.com/cbr/?agencyId=97fcd896b7914cb98f553a087232e243®ion=testregion/cbr/manager/csbs/vaultList" }, "description" : "vault_description", "name" : "vault_name", "resources" : [ { "extra_info" : { "exclude_volumes" : [ "43a320a5-3efd-4568-b1aa-8dd9183cc64b" ] }, "id" : "23a320a5-3efd-4568-b1aa-8dd9183cc64c", "type" : "OS::Nova::Server" } ], "tags" : [ { "key" : "key01", "value" : "value01" } ], "enterprise_project_id" : "0" } } 创建一个云硬盘备份存储库，存储库容量为40G,按需计费。 POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults { "vault" : { "billing" : { "consistent_level" : "crash_consistent", "object_type" : "disk", "protect_type" : "backup", "size" : 40, "charging_mode" : "post_paid", "is_auto_renew" : false, "is_auto_pay" : false }, "name" : "test", "resources" : [ ] } }

响应示例 状态码： 200 OK { "vault" : { "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66", "description" : "vault_description", "tags" : [ { "value" : "value01", "key" : "key01" } ], "enterprise_project_id" : 0, "auto_bind" : false, "id" : "ad7627ae-5b0b-492e-b6bd-cd809b745197", "user_id" : "38d65be2ecd840d19046e239e841a734", "name" : "vault_name", "billing" : { "status" : "available", "used" : 0, "protect_type" : "backup", "object_type" : "server", "allocated" : 40, "spec_code" : "vault.backup.server.normal", "size" : 100, "cloud_type" : "public", "consistent_level" : "crash_consistent", "charging_mode" : "post_paid" }, "created_at" : "2019-05-23T12:51:10.071+00:00", "project_id" : "fc347bc64ccd4589ae52e4f44b7433c7", "resources" : [ { "name" : "ecs-b977-0002", "backup_size" : 0, "protect_status" : "available", "backup_count" : 0, "extra_info" : { "exclude_volumes" : [ "1855eb9a-2b5e-4938-a9f0-aea08b6f9243", "5a51e8b3-2f65-4045-896f-f8ffae14b064" ] }, "type" : "OS::Nova::Server", "id" : "23a320a5-3efd-4568-b1aa-8dd9183cc64c", "size" : 40 } ] } }

响应示例 状态码： 200 OK { "operation_log" : { "status" : "success", "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66", "checkpoint_id" : "b432511f-d889-428f-8b0e-5f47c524c6b6", "updated_at" : "2019-05-23T14:35:23.584+00:00", "error_info" : { "message" : "", "code" : "" }, "started_at" : "2019-05-23T14:31:36.007+00:00", "id" : "4827f2da-b008-4507-ab7d-42d0df5ed912", "extra_info" : { "resource" : { "type" : "OS::Nova::Server", "id" : "1dab32fa-ebf2-415a-ab0b-eabe6353bc86", "name" : "E CS -0001" }, "backup" : { "backup_name" : "manualbk_1234", "backup_id" : "0e5d0ef6-7f0a-4890-b98c-cb12490e31c1" }, "common" : { "progress" : 100, "request_id" : "req-cdb98cc4-e87b-4f40-9b4a-57ec036620bc" } }, "ended_at" : "2019-05-23T14:35:23.511+00:00", "created_at" : "2019-05-23T14:31:36.039+00:00", "operation_type" : "backup", "project_id" : "04f1829c788037ac2fb8c01eb2b04b95" } } 状态码： 404 任务ID不存在 { "error_code" : "BackupService.6500", "error_msg" : "Operation log does not exist." }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 operation_log OperationLog object 任务信息 表4 OperationLog 参数 参数类型 描述 checkpoint_id String 备份记录id created_at String 创建时间,例如: "2020-02-23T01:00:32Z" ended_at String 任务结束时间,例如: "2020-02-23T01:00:32Z" error_info OpErrorInfo object 任务错误信息 extra_info OpExtraInfo object 任务扩展信息 id String 任务id operation_type String 任务类型 backup: 备份 copy: 复制 replication: 跨Region复制 restore: 恢复 delete: 删除 sync: 同步 vault_delete: 删除存储库 remove_resource: 移除资源 policy_id String 策略ID project_id String 项目ID provider_id String 备份提供商ID。用于区分备份对象。 started_at String 任务开始时间,例如: "2020-02-23T01:00:32Z" status String 任务状态 success: 成功 skipped: 跳过 failed: 失败 running: 运行中 timeout: 超时 waiting: 等待中 updated_at String 修改时间,例如: "2020-02-23T01:00:32Z" vault_id String 任务操作资源所属存储库ID vault_name String 任务操作资源所属存储库名称 表5 OpErrorInfo 参数 参数类型 描述 code String 请参见错误码。 message String 错误信息 表6 OpExtraInfo 参数 参数类型 描述 backup OpExtendInfoBckup object 备份扩展参数 common OpExtendInfoCommon object 公共参数 delete OpExtendInfoDelete object 删除扩展参数 sync OpExtendInfoSync object 扩展同步信息 remove_resources OpExtendInfoRemoveResources object 移除Vault的资源 replication OpExtendInfoReplication object 扩展复制信息 resource Resource object 资源信息 restore OpExtendInfoRestore object 扩展恢复信息 vault_delete OpExtendInfoVaultDelete object 删除vault 表7 OpExtendInfoBckup 参数 参数类型 描述 app_consistency_error_code String 应用一致性备份失败错误码。请参见错误码。 app_consistency_error_message String 应用一致性备份错误信息 app_consistency_status String 应用一致性备份状态 0: 非应用一致性 1: 应用一致性备份 backup_id String 备份副本ID backup_name String 备份名称 incremental String 是否增备 "true" "false" 表8 OpExtendInfoCommon 参数 参数类型 描述 progress Integer 进度，取值为0-100 最小值：0 最大值：100 request_id String 请求id task_id String 备份任务id 表9 OpExtendInfoDelete 参数 参数类型 描述 backup_id String 备份副本ID backup_name String 备份名称 表10 OpExtendInfoSync 参数 参数类型 描述 sync_backup_num Integer 同步备份副本数 delete_backup_num Integer 删除的备份副本数 err_sync_backup_num Integer 同步失败备份副本数 表11 OpExtendInfoRemoveResources 参数 参数类型 描述 fail_count Integer 删除失败的资源数量 total_count Integer 删除的备份数量 resources Array of Resource objects 资源信息 表12 Resource 参数 参数类型 描述 extra_info ResourceExtraInfo object 资源附加信息 id String 待备份资源id name String 待备份资源名称，长度限制：0-255 最小长度：0 最大长度：255 type String 待备份资源的类型: OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo, OS::Workspace::DesktopV2 表13 OpExtendInfoReplication 参数 参数类型 描述 destination_backup_id String 目标副本ID destination_checkpoint_id String 目标还原点ID destination_project_id String 目标project_id destination_region String 目标区域 source_backup_id String 源副本ID source_checkpoint_id String 源还原点ID source_project_id String 源project_id source_region String 源区域 source_backup_name String 源备份名称 destination_backup_name String 目标备份名称 表14 ResourceExtraInfo 参数 参数类型 描述 exclude_volumes Array of strings 需要排除备份的卷id。仅在多盘备份特性中有效，排除不需要备份的磁盘。当虚拟机新绑定磁盘时，也能继续排除之前设置不用备份的卷。 表15 OpExtendInfoRestore 参数 参数类型 描述 backup_id String 备份副本ID backup_name String 备份名称 target_resource_id String 恢复目标资源ID target_resource_name String 恢复目标资源名称 表16 OpExtendInfoVaultDelete 参数 参数类型 描述 fail_count Integer 本次任务删除失败的资源数量 total_count Integer 本次任务删除的备份总数 状态码： 404 表17 响应Body参数 参数 参数类型 描述 error_code String 请参见错误码。 error_msg String 错误信息

响应示例 状态码： 200 OK { "vault" : { "id" : "2b076f26-391f-40fa-bf71-a798940faccf", "name" : "sdk-vault1595581958", "resources" : [ ], "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66", "created_at" : "2020-07-24T09:12:49.492+00:00", "project_id" : "0605767b5780d5762fc5c0118072a564", "enterprise_project_id" : 0, "auto_bind" : true, "bind_rules" : { }, "auto_expand" : false, "user_id" : "aa2999fa5ae640f28926f8fd79188934", "billing" : { "allocated" : 0, "cloud_type" : "public", "consistent_level" : "crash_consistent", "charging_mode" : "post_paid", "protect_type" : "backup", "object_type" : "server", "spec_code" : "vault.backup.server.normal", "used" : 0, "status" : "available", "size" : 40 }, "tags" : [ { "key" : "fds" } ] } }

响应参数 状态码： 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

响应示例 状态码： 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" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 members 是 Array of strings 列表，待添加备份共享成员的project_id。 数组长度：1 - 10

API概览 云备份所提供的接口均为CBR接口，您可以通过这些接口完整的使用云备份的所有功能。 表1 接口说明 类型 说明 任务 可以查询任务列表和单个任务的情况。 可保护性 可以查询所在区域的复制能力，本区域是否支持复制备份和存储库。 存储库 可以实现创建存储库、存储库查询、为存储库绑定策略等操作。 备份共享 用户可以将备份共享给其他用户使用。通过备份共享的接口完成备份共享的相关操作。 还原点 可以实现对存储库执行备份、执行复制的操作，以及查询备份和复制创建的时间。 备份 可以实现查询备份、同步备份副本、使用备份恢复数据等操作。 策略 绑定策略的存储库可以定期执行备份。通过策略相关接口完成创建策略、修改策略、查询策略等操作。 标签 可对存储库进行标签添加、编辑或删除操作。此处的标签仅用于存储库的过滤和管理。

URI GET /v3/{project_id}/vaults 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 表2 Query参数 参数 是否必选 参数类型 描述 cloud_type 否 String 公有云:public ;混合云:hybrid enterprise_project_id 否 String 企业项目id或all_granted_eps，all_granted_eps表示查询用户有权限的所有企业项目id id 否 String 存储库ID limit 否 Integer 每页显示条目数，正整数 最小值：1 最大值：1000 name 否 String 存储库名称 object_type 否 String 对象类型：云服务器（server），云硬盘（disk），文件系统（turbo），云桌面（workspace），VMware（vmware），关系型数据库（rds），文件（file）。 offset 否 Integer 偏移值,正整数 policy_id 否 String 策略ID protect_type 否 String 保护类型：备份（backup）、复制(replication)。 resource_ids 否 String 资源id，支持多资源，以英文逗号分割 status 否 String 状态

响应示例 状态码： 200 OK { "vaults" : [ { "id" : "a335f9e1-1628-4c64-a7be-38656e5ec19c", "name" : "vault-8538", "resources" : [ ], "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66", "created_at" : "2020-09-04T06:57:37.344+00:00", "project_id" : "0605767b5780d5762fc5c0118072a564", "enterprise_project_id" : 0, "auto_bind" : false, "bind_rules" : { }, "auto_expand" : false, "user_id" : "aa2999fa5ae640f28926f8fd79188934", "billing" : { "allocated" : 0, "cloud_type" : "public", "consistent_level" : "crash_consistent", "charging_mode" : "post_paid", "protect_type" : "backup", "object_type" : "server", "spec_code" : "vault.backup.server.normal", "used" : 0, "status" : "available", "size" : 100 }, "tags" : [ ] } ], "count" : 50 }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 associate_policy VaultPolicyResp object 绑定策略详情 表5 VaultPolicyResp 参数 参数类型 描述 destination_vault_id String 目标region的vault ID，仅设置复制策略时有。 policy_id String 设置的策略ID vault_id String 设置策略的vault ID

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 destination_vault_id 否 String 目标vault ID , 只有设置复制策略时使用，而且必传 policy_id 否 String 策略ID。policy_id字段与add_policy_ids字段在一次请求中有且只有一个。 add_policy_ids 否 Array of strings 多策略场景下，绑定新策略的id列表。policy_id字段与add_policy_ids字段在一次请求中有且只有一个。 最小长度：1 最大长度：10

响应示例 状态码： 200 OK { "vault" : { "name" : "vault_name02", "billing" : { "status" : "available", "used" : 0, "protect_type" : "backup", "object_type" : "server", "allocated" : 40, "spec_code" : "vault.backup.server.normal", "size" : 200, "cloud_type" : "public", "consistent_level" : "crash_consistent", "charging_mode" : "post_paid" }, "tags" : [ { "value" : "value01", "key" : "key01" } ], "created_at" : "2019-05-08T09:31:21.840+00:00", "project_id" : "4229d7a45436489f8c3dc2b1d35d4987", "enterprise_project_id" : 0, "id" : "2402058d-8373-4b0a-b848-d3c0dfdc71a8", "resources" : [ { "name" : "ecs-1f0f-0003", "protect_status" : "available", "extra_info" : { "exclude_volumes" : [ "bdef09bb-293f-446a-88a4-86e9f14408c4" ] }, "type" : "OS::Nova::Server", "id" : "97595625-198e-4e4d-879b-9d53f68ba551", "size" : 40 } ], "description" : "vault_description" } }

请求示例 修改一个存储库，容量为200G，名称为vault_name02。 PUT https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults/79bd9daa-884f-4f84-b8fe-235d58cd927d { "vault" : { "billing" : { "size" : 200 }, "name" : "vault_name02" } }

响应参数 状态码： 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", "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" } }

请求示例 修改一个备份策略，周一到周天每天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" ] } } } }