华为云用户手册

响应示例 状态码： 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" : "ECS-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 错误信息

请求示例 同步线下混合云VMware备份副本。 POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/backups/sync { "sync" : [ { "backup_id" : "1f9e6b47-7655-4a19-b563-21b4ef023025", "resource_id" : "96f7512d-239d-3f31-80cf-d1ce041df9a6", "resource_name" : "resource_name", "resource_type" : "OS::Native::Server", "bucket_name" : "1555230361623e4ce4700dab84b7d8169a5eaec05227d", "image_path" : "6abec15e-7baf-4d79-b5a9-6b98a2da7020/cfe0295c-5939-4b31-96cd-161b4725e7ad/cfe0295c-5939-4b31-96cd-161b4725e7ad", "created_at" : 1553587260, "backup_name" : "backup_name" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 sync 是 Array of BackupSync objects 待同步备份副本列表 数组长度：1 - 50 表4 BackupSync 参数 是否必选 参数类型 描述 backup_id 是 String 备份副本ID backup_name 是 String 备份名称 最小长度：1 最大长度：64 bucket_name 是 String 桶名 image_path 是 String 备份链在存储单元上的路径 resource_id 是 String 备份对象ID resource_name 是 String 备份对象名称 resource_type 是 String 备份对象资源类型 缺省值：OS::Native::Server created_at 是 Integer 备份时间戳，例如1548898428

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

请求示例 创建一个包周期云服务器备份存储库，存储库容量为80G，周期为一个月且绑定一个资源。 POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults/order { "vault" : { "name" : "vault_name", "billing" : { "consistent_level" : "app_consistent", "object_type" : "server", "protect_type" : "backup", "size" : 80, "charging_mode" : "pre_paid", "period_type" : "month", "period_num" : 1 }, "resources" : [ { "id" : "23a320a5-3efd-4568-b1aa-8dd9183cc64c", "type" : "OS::Nova::Server" } ] } } 创建一个包周期云服务器备份存储库，存储库容量阈值为80G，云服务器数量为5，周期为一个月同时绑定一个资源并添加标签。 POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults/order { "vault" : { "name" : "123", "description" : "description", "backup_policy_id" : "70e9c916-7109-472d-94e7-120900e4ba61", "tags" : [ { "key" : "key", "value" : "value" } ], "auto_bind" : false, "threshold" : 80, "smn_notify" : true, "parameters" : { "combined_order" : { "combined_order_id" : "CS2303030959MR1IT", "combined_order_ecs_num" : 5, "combined_order_num" : 5 } }, "bind_rules" : { "tags" : [ { "key" : "bind_rules_key", "value" : "bind_rules_value" } ] }, "billing" : { "cloud_type" : "public", "is_auto_renew" : false, "is_auto_pay" : false, "console_url" : "https://www.com", "consistent_level" : "app_consistent", "object_type" : "server", "protect_type" : "backup", "size" : 80, "charging_mode" : "pre_paid", "period_type" : "month", "period_num" : 1 }, "resources" : [ { "id" : "8ef08ba1-81f7-4e41-ae49-d3e2fb0ba388", "type" : "OS::Nova::Server", "name" : "server_name", "extra_info" : { "exclude_volumes" : [ "1855eb9a-2b5e-4938-a9f0-aea08b6f9243" ] } } ] } }

响应示例 状态码： 200 OK { "orders" : [ { "orderId" : "CS2303030941NJJIW", "cloudServiceId" : "cbr", "subscribeResult" : 1, "resourceId" : "ef3bf6bb-1ffb-46c0-8b23-f935ded5024a" } ], "retCode" : 0, "errText" : "success", "error_code" : 0 }

响应参数 状态码： 200 表13 响应Body参数 参数 参数类型 描述 orders Array of CbcOrderResult objects 订单详情 retCode Integer 创建结果代码 0：成功 errText String 创建结果信息 error_code String 操作错误码 0：无错误 表14 CbcOrderResult 参数 参数类型 描述 cloudServiceId String 云服务ID orderId String 订单ID subscribeResult Integer 订购结果，1：成功；0：失败 resourceId String 包周期资源预生成资源id。 状态码： 400 表15 响应Body参数 参数 参数类型 描述 error_code String 请参见错误码。 error_msg String 错误信息

响应示例 状态码： 200 OK { "replication" : { "destination_vault_id" : "0ca3eb86-8800-46da-9c37-9d657a825274", "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66", "source_region" : "region1", "vault_id" : "3b5816b5-f29c-4172-9d9a-76c719a659ce", "destination_region" : "region2", "destination_project_id" : "68589cac08274b82b4e254268a3862d8", "backups" : [ { "replication_record_id" : "de128dfa-5451-4905-9c11-8fc842b2f41e", "backup_id" : "7558e1a3-7046-4787-95cd-14b0ad0642a8" }, { "replication_record_id" : "892a7d1e-17c8-4751-ad75-cfbed7051857", "backup_id" : "6df2b54c-dd62-4059-a07c-1b8f24f2725d" }, { "replication_record_id" : "8bf5ce8f-bfa1-4d57-98de-d6159ab9d86d", "backup_id" : "aa00034d-ef40-443d-ab7a-dc846d988cdf" } ], "project_id" : "4229d7a45436489f8c3dc2b1d35d4987" } }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 replication CheckpointReplicateRespBody object 复制备份还原点响应对象。 表6 CheckpointReplicateRespBody 参数 参数类型 描述 backups Array of CheckpointReplicateRespbackups objects 待复制的备份列表 destination_project_id String 复制的目标项目ID destination_region String 复制的目标区域 destination_vault_id String 目标区域存储库ID project_id String 执行复制的项目ID provider_id String 备份提供商ID source_region String 复制的源区域 vault_id String 存储库ID 表7 CheckpointReplicateRespbackups 参数 参数类型 描述 backup_id String 待复制的备份ID replication_record_id String 复制记录ID

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 replicate 是 CheckpointReplicateParam object 执行复制请求体参数 表4 CheckpointReplicateParam 参数 是否必选 参数类型 描述 auto_trigger 否 Boolean 本次复制是否自动触发，默认为false，代表手动触发 destination_project_id 是 String 复制的目标项目ID destination_region 是 String 复制的目标区域id 最小长度：0 最大长度：255 destination_vault_id 是 String 目标区域存储库ID enable_acceleration 否 Boolean 跨区域复制时，是否启用加速从而缩短复制的时间，如果不指定，默认不启用加速，如果启用加速，会额外收取加速的费用。 vault_id 是 String 存储库ID: uuid

请求示例 手动跨区域复制一个备份副本从源区域到目标区域。 POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/checkpoints/replicate { "replicate" : { "auto_trigger" : false, "destination_project_id" : "68589cac08274b82b4e254268a3862d8", "destination_region" : "region2", "destination_vault_id" : "0ca3eb86-8800-46da-9c37-9d657a825274", "enable_acceleration" : false, "vault_id" : "3b5816b5-f29c-4172-9d9a-76c719a659ce" } }

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 OK { "projects" : [ { "project_name" : "cn-north-7", "project_id" : "fe1431a61f4242dd87e548f8f42ec0b4" }, { "project_name" : "cn-north-7-virtual", "project_id" : "bccd81411c254e6890fe88d2f2ce406b" } ] }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 status String 租户迁移状态 success: 成功 failed: 异常 migrating: 迁移中 project_status Array of DomainMigrateProjectStatus objects 项目迁移状态 表3 DomainMigrateProjectStatus 参数 参数类型 描述 status String 迁移状态 migrating: 迁移中 success: 成功 failed: 异常 project_id String 项目ID project_name String 项目名称 region_id String 区域ID progress Integer 迁移进度 最小值：0 最大值：100 fail_code Integer 失败错误码（仅当项目状态为失败时才有该参数）。 fail_reason String 失败原因（仅当项目状态为失败时才有该参数）。

响应示例 状态码： 200 OK { "status" : "failed", "project_status" : [ { "status" : "failed", "progress" : 1, "project_id" : "fe1431a61f4242dd87e548f8f42ec0b4", "project_name" : "cn-north-7", "region_id" : "cn-north-7", "fail_code" : 4002, "fail_reason" : "An error occurred when converting models: dictionary keys changed during iteration." }, { "status" : "success", "progress" : 100, "project_id" : "bccd81411c254e6890fe88d2f2ce406b", "project_name" : "cn-north-7-virtual", "region_id" : "cn-north-7" } ] }

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

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 表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" } }

URI GET /v3/{project_id}/storage_usage 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 查询条数 offset 否 Integer 偏移值 resource_id 否 String 支持按照备份对象ID过滤 resource_type 否 String 支持按照备份对象类型过滤

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 resource_count Integer 满足过滤条件的资源总条数。 storage_usage Array of StorageUsage objects 容量统计。 表4 StorageUsage 参数 参数类型 描述 backup_count Integer 备份数量 backup_size Integer 备份容量 resource_id String 资源ID resource_name String 资源名称 resource_type String 资源类型 backup_size_multiaz Integer 多AZ备份大小

响应示例 状态码： 200 OK { "storage_usage" : [ { "resource_name" : "ECS_name", "resource_id" : "89d466e5-b7f9-4e45-807a-d5f17f44fc84", "backup_size" : 0, "backup_count" : 1, "resource_type" : "OS::Nova::Server", "backup_size_multiaz" : 0 } ], "resource_count" : 1 }

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