云备份 CBR-华为云

云备份 CBR-迁移资源:请求示例

请求示例迁移备份资源从源存储库到目标存储库且不删除源备份。 POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults/79bd9daa-884f-4f84-b8fe-235d58cd927d/migrateresources { "resource_ids" : [ "abcdde3f-e0e3-403a-b690-fc259dd70008" ], "destination_vault_id" : "fe578a6c-d1a8-4790-bd52-5954af4d446c" }

云备份 CBR

云备份 CBR-迁移资源:请求参数

请求参数表2 请求Header参数参数是否必选参数类型描述 X-Auth-Token 否 String 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。表3 请求Body参数参数是否必选参数类型描述 destination_vault_id 是 String 目标存储库 resource_ids 是 Array of strings 待迁移的资源ID

云备份 CBR

云备份 CBR-更新备份:响应示例

响应示例状态码：200 OK { "backup" : { "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66", "checkpoint_id" : "8b0851a8-adf3-4f4c-a914-dead08bf9664", "enterprise_project_id" : 0, "vault_id" : "3b5816b5-f29c-4172-9d9a-76c719a659ce", "id" : "6df2b54c-dd62-4059-a07c-1b8f24f2725d", "resource_az" : "az1.dc1", "image_type" : "backup", "resource_id" : "94eba8b2-acc9-4d82-badc-127144cc5526", "resource_size" : 40, "children" : [ { "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66", "checkpoint_id" : "8b0851a8-adf3-4f4c-a914-dead08bf9664", "vault_id" : "3b5816b5-f29c-4172-9d9a-76c719a659ce", "id" : "5d822633-2bbf-4af8-a16e-5ab1c7705235", "image_type" : "backup", "resource_id" : "eccbcfdd-f843-4bbb-b2c0-a5ce861f9376", "resource_size" : 40, "children" : [ ], "parent_id" : "6df2b54c-dd62-4059-a07c-1b8f24f2725d", "extend_info" : { "auto_trigger" : true, "snapshot_id" : "5230a977-1a94-4092-8edd-519303a44cda", "bootable" : true, "encrypted" : true }, "project_id" : "4229d7a45436489f8c3dc2b1d35d4987", "status" : "available", "resource_name" : "ecs-1f0f-0002", "replication_records" : [ ], "name" : "autobk_a843_ecs-1f0f-0002", "created_at" : "2019-05-10T07:59:59.451+00:00", "resource_type" : "OS::Cinder::Volume" } ], "extend_info" : { "auto_trigger" : true, "supported_restore_mode" : "backup", "contain_system_disk" : true, "support_lld" : true }, "project_id" : "4229d7a45436489f8c3dc2b1d35d4987", "status" : "available", "resource_name" : "ecs-1f0f-0002", "description" : "backup_description", "replication_records" : [ ], "name" : "backup-name02", "created_at" : "2019-05-10T07:59:12.085+00:00", "resource_type" : "OS::Nova::Server" } }

云备份 CBR

云备份 CBR-更新备份:响应参数

响应参数状态码：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 是否是增备 version Integer 备份副本快照类型表6 BackupExtendInfo 参数参数类型描述 auto_trigger Boolean 是否是自动生成的备份副本 bootable Boolean 是否系统盘备份 snapshot_id String 卷备份副本的快照id support_lld Boolean 是否支持lazyloading快速恢复 supported_restore_mode String 备份支持恢复的方式 na: 备份不支持直接恢复，只支持备份创建新资源等操作。 backup: 备份支持通过云服务器上硬盘的备份进行恢复。 snapshot: 备份此时已经支持创建整机镜像。 os_images_data Array of ImageData objects 备份注册镜像ID列表 contain_system_disk Boolean 整机备份是否包含系统盘 encrypted Boolean 是否加密 system_disk Boolean 是否是系统盘 is_multi_az Boolean 备份类型是否为多AZ 表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

云备份 CBR

云备份 CBR-创建备份还原点:请求示例

请求示例执行存储库资源自动备份，生成备份还原点。 POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/checkpoints { "checkpoint" : { "parameters" : { "auto_trigger" : true, "description" : "backup_description", "incremental" : true, "name" : "backup_name", "resources" : [ "94eba8b2-acc9-4d82-badc-127144cc5526" ] }, "vault_id" : "3b5816b5-f29c-4172-9d9a-76c719a659ce" } }

云备份 CBR

云备份 CBR-创建备份还原点:响应示例

响应示例状态码：200 OK { "checkpoint" : { "status" : "protecting", "created_at" : "2019-05-10T07:59:12.733+00:00", "vault" : { "skipped_resources" : [ ], "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", "extra_info" : { "retention_duration" : -1, "name" : "backup_name", "description" : "backup_description" } } }

云备份 CBR

云备份 CBR-创建备份还原点:响应参数

响应参数状态码：200 表8 响应Body参数参数参数类型描述 checkpoint CheckpointCreate object 还原点信息表9 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 扩展信息表10 CheckpointPlanCreate 参数参数类型描述 id String 存储库id name String 存储库名称 resources Array of CheckpointResourceResp objects 备份对象 skipped_resources Array of CheckpointCreateSkippedResource objects 备份时跳过的资源列表表11 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 副本数量表12 CheckpointCreateSkippedResource 参数参数类型描述 id String 资源ID type String 资源类型 name String 资源名称 code String 请参见错误码。 reason String 跳过原因，例如：该资源正在备份中。表13 CheckpointExtraInfoResp 参数参数类型描述 name String 备份名称 description String 备份描述 retention_duration Integer 备份保留天数

云备份 CBR

云备份 CBR-创建备份还原点:请求参数

请求参数表2 请求Header参数参数是否必选参数类型描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。表3 请求Body参数参数是否必选参数类型描述 checkpoint 是 VaultBackup object 存储库执行备份参数表4 VaultBackup 参数是否必选参数类型描述 parameters 否 CheckpointParam object 参数 vault_id 是 String 存储库ID 表5 CheckpointParam 参数是否必选参数类型描述 auto_trigger 否 Boolean 是否自动触发,true:自动触发，false：非自动触发。 description 否 String 备份描述 incremental 否 Boolean 是否增量备份，true:增量备份，false：非增量备份。 name 否 String 备份名称，只能由数字、中文、英文大小写字母，以及下划线"_"和中横线 "-" 字符构成。 resources 否 Array of strings 待备份的资源id列表:uuid resource_details 否 Array of Resource objects 资源详情表6 Resource 参数是否必选参数类型描述 extra_info 否 ResourceExtraInfo object 资源附加信息 id 是 String 待备份资源id name 否 String 待备份资源名称，长度限制：0-255 type 是 String 待备份资源的类型: OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo, OS::Workspace::DesktopV2 表7 ResourceExtraInfo 参数是否必选参数类型描述 exclude_volumes 否 Array of strings 需要排除备份的卷id。仅在多盘备份特性中有效，排除不需要备份的磁盘。当虚拟机新绑定磁盘时，也能继续排除之前设置不用备份的卷。

云备份 CBR

云备份 CBR-查询客户端列表:响应示例

响应示例状态码：200 OK { "count" : 2, "limit" : 1000, "offset" : 0, "agents" : [ { "created_at" : "2022-01-30T09:28:09.334+00:00", "agent_id" : "489654f2-363b-4ebf-966a-bdf079d97114", "host_name" : "eBackup", "host_ip" : "18.9.158.36", "status" : "normal", "last_active_time" : "2022-01-30T09:28:08.960+00:00" }, { "created_at" : "2022-01-14T06:47:17.524+00:00", "updated_at" : "2022-01-28T05:01:32.739+00:00", "agent_id" : "fb711278-e872-4224-b442-8dafc36a543d", "host_name" : "ecs-00001", "host_ip" : "10.10.0.1", "status" : "normal", "last_active_time" : "2022-01-28T05:01:32.000+00:00", "paths" : [ { "id" : "6c3d1ed6-b7d7-4e27-94ee-321431e84c5c", "dir_path" : "/home/hcp", "status" : "available", "agent_id" : "fb711278-e872-4224-b442-8dafc36a543d", "exclude_paths" : "*.txt,/opt/huaweicloud/cbragent/lib/test" }, { "id" : "e2af0fdd-9644-4db8-986e-5a6a2395c390", "dir_path" : "/opt/workspace", "status" : "available", "agent_id" : "fb711278-e872-4224-b442-8dafc36a543d", "exclude_paths" : "*.txt,/opt/huaweicloud/cbragent/lib/test" } ] } ] }

云备份 CBR

云备份 CBR-查询客户端列表:URI

URI GET /v3/{project_id}/agents 表1 路径参数参数是否必选参数类型描述 project_id 是 String 项目ID 表2 Query参数参数是否必选参数类型描述 agent_id 否 String 客户端ID limit 否 String 每页显示条目数，正整数 offset 否 Integer 偏移值,正整数 status 否 String 状态

云备份 CBR

云备份 CBR-查询客户端列表:响应参数

响应参数状态码：200 表4 响应Body参数参数参数类型描述 agents Array of Agent objects 客户端实例列表 count Integer 客户端个数 limit Integer 每页显示的条目数量 offset Integer 偏移量，表示从此偏移量开始查询表5 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 客户端的备份路径表6 Path 参数参数类型描述 id String 路径ID status String 路径状态，有available和remove两种状态 agent_id String 该路径所属于的客户端ID dir_path String 路径详情 exclude_paths String 排除目录列表，多个路径之间以英文逗号分隔。说明：该特性目前处于公测阶段,部分region可能无法使用。

云备份 CBR

云备份 CBR-查询其他区域存储库列表:响应示例

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

云备份 CBR

云备份 CBR-查询其他区域存储库列表:URI

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 每页显示条目数 objcet_type 否 String 资源类型 offset 否 Integer 偏移值 protect_type 否 String 保护类型。取值为backup，replication和hybrid。 region_id 是 String 区域ID vault_id 否 String 存储库ID，指定存储ID时其他过滤条件不生效。

云备份 CBR

云备份 CBR-注册客户端:响应参数

响应参数状态码：200 表5 响应Body参数参数参数类型描述 agent Agent object 客户端详情表6 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 客户端的备份路径表7 Path 参数参数类型描述 id String 路径ID status String 路径状态，有available和remove两种状态 agent_id String 该路径所属于的客户端ID dir_path String 路径详情 exclude_paths String 排除目录列表，多个路径之间以英文逗号分隔。说明：该特性目前处于公测阶段,部分region可能无法使用。

云备份 CBR

云备份 CBR-注册客户端:请求示例

请求示例注册客户端由agent安装时自动触发，无需客户手动调用。 POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/agents { "agent" : { "agent_id" : "489654f2-363b-4ebf-966a-bdf079d97114", "host_name" : "ecs-00002", "host_ip" : "10.10.0.2", "host_os" : "linux", "agent_version" : "1.0.0", "agent_type" : "native" } }

云备份 CBR

云服务器内容精选

云备份 CBR

7*24

备案

专业服务

退订

建议反馈

售前咨询热线