华为云用户手册

安全组 安全组是一种虚拟防火墙，具备状态检测和数据包过滤功能，用于设置弹性云服务器、裸金属服务器、负载均衡、数据库等实例的网络访问控制，是重要的网络安全隔离手段。 您可以通过配置安全组规则，允许安全组内的实例对公网或私网的访问。 安全组是一个逻辑上的分组，您可以将同一区域内具有相同安全保护需求的裸金属服务器加入到同一个安全组内。 同一安全组内的BMS实例之间默认内网网络互通，不同安全组内的实例之间默认内网不通。 您可以随时修改安全组的规则，新规则立即生效。

裸金属服务器类型与支持的操作系统版本 裸金属服务器不同规格操作系统兼容性列表如下所示。操作系统版本均为64bit。 使用X86 V4版本（CPU采用Intel Broadwell架构）的服务器请参考表1。 使用X86 V5版本（CPU采用Intel Skylake架构）的服务器请参考表2。 使用X86 V6版本（CPU采用Intel Cascade Lake架构）的服务器请参考表3。 使用鲲鹏CPU的服务器请参考表4。 建议您使用操作系统官方发行版本进行系统构建，避免对发行版本进行裁剪及高度定制，以减少问题发生概率。 操作系统发行版本由操作系统厂商进行不定期版本更迭，部分系统版本厂商已停止维护，不再发布问题修复及安全补丁，建议及时关注厂商公告进行系统升级更新，保证您系统的健壮性。 CentOS 7.4及以下版本的7系列操作系统，因已知的内核问题会导致无法ping通裸金属服务器扩展网卡网关，涉及扩展网卡相关业务建议使用CentOS 7.5及以上系统版本，具体请参考如何处理CentOS 7系列扩展网卡无法ping通的问题？ 表1 裸金属服务器兼容性列表（V4） 类型 CentOS SUSE Ubuntu EulerOS 本地存储型d1 physical.d1.large CentOS 6.7/6.8/6.9/6.10/7.2/7.3/7.4/7.5/7.6 SUSE Linux Enterprise 11.SP4/12.SP1/12.SP2/12.SP3 Ubuntu 14.04.5 LTS Ubuntu 16.04 LTS EulerOS 2.2/2.3 通用型规格s3 physical.s3.large physical.s3.xlarge physical.s3.2xlarge CentOS 6.7/6.8/6.9/6.10/7.2/7.3/7.4/7.5/7.6 SUSE Linux Enterprise 11.SP4/12.SP1/12.SP2/12.SP3 Ubuntu 14.04.5 LTS Ubuntu 16.04 LTS EulerOS 2.2/2.3 内存优化型规格m2 physical.m2.small physical.m2.mediumphysical.m2.large physical.m2.xlarge CentOS 7.2 - - - IO优化型规格io1 physical.io1.large CentOS 6.7/6.8/6.9/7.2/7.3/7.4/7.5/7.6 SUSE Linux Enterprise 11.SP4/12.SP1/12.SP2/12.SP3 Ubuntu 14.04.5 LTS Ubuntu 16.04 LTS EulerOS 2.2/2.3 GPU加速型规格 physical.p1.large physical.p2.large physical.g1.small CentOS 7.4/7.5/7.6 - Ubuntu 16.04 LTS EulerOS 2.3 表2 裸金属服务器兼容性列表（V5） 类型 CentOS SUSE Ubuntu EulerOS 本地存储型d2 physical.d2.large physical.d2.tiny physical.d2.xmedium CentOS 6.7/6.8/6.9/7.2/7.3/7.4/7.5/7.6 SUSE Linux Enterprise 11.SP4/12.SP1/12.SP2/12.SP3 Ubuntu 14.04.5 LTS Ubuntu 16.04 LTS EulerOS 2.3 通用型规格s4 physical.s4.medium physical.s4.large physical.s4.xlarge physical.s4.2xlarge physical.s4.3xlarge CentOS 6.9/7.3/7.4/7.5/7.6 SUSE Linux Enterprise 11.SP4/12.SP2/12.SP3 Ubuntu 14.04.5 LTS Ubuntu 16.04 LTS EulerOS 2.3 IO优化型规格io2 physical.io2.xlarge CentOS 6.9/7.3/7.4/7.5/7.6 SUSE Linux Enterprise 11.SP4/12.SP2/12.SP3 Ubuntu 16.04 LTS EulerOS 2.3 高性能计算型规格h2 physical.h2.large CentOS 6.9/7.3/7.4/7.5/7.6 SUSE Linux Enterprise 11.SP4 Ubuntu 16.04 LTS EulerOS 2.3 高性能计算型规格hc2 physical.hc2.xlarge CentOS 6.9/7.3/7.4/7.5/7.6 SUSE Linux Enterprise 11.SP4/12.SP2/12.SP3 Ubuntu 14.04.5 LTS Ubuntu 16.04 LTS EulerOS 2.3 GPU加速型规格p3 physical.p3.large - - - EulerOS 2.3 表3 裸金属服务器兼容性列表（V6） 类型 CentOS SUSE Ubuntu EulerOS 通用型规格c6 physical.c6s.3xlarge physical.c6sd.3xlarge physical.c6sd.6xlarge CentOS 7.6/7.8/7.9/8.2 SUSE Linux Enterprise 15.SP2 Ubuntu 18.04.3 LTS EulerOS 2.5 高性能计算型规格h6 physical.h6.large CentOS 7.6/7.8/7.9 - - - GPU加速型规格pi6 physical.pi6.3xlarge.6 CentOS 7.6 - - - 表4 裸金属服务器兼容性列表（鲲鹏） 类型 CentOS HCE EulerOS physical.ks1ne.2xlarge physical.ks1ne.4xlarge physical.ks1ne.8xlarge CentOS 7.6 Huawei Cloud EulerOS 2.0 EulerOS 2.8 physical.kd1ne.2xlarge physical.kd1ne.4xlarge CentOS 7.6 Huawei Cloud EulerOS 2.0 EulerOS 2.8 physical.kat1.6xlarge - - EulerOS 2.8 physical.ks1.2xlarge CentOS 7.6 - - 父主题： 镜像

实例生命周期 生命周期是指一台裸金属服务器实例从创建到删除所经历的所有状态，本章节简单描述各个状态的详情，以及状态之间的转换。 图1 裸金属服务器状态转换 表1 裸金属服务器状态说明 状态 状态属性 说明 API对应的状态 创建中 中间状态 创建裸金属服务器后，裸金属服务器状态进入运行中之前的状态。 如果长时间处于该状态，则说明出现异常，需要联系运营管理员处理。 BUILD/BUILDING 正在开机 中间状态 裸金属服务器从关机到运行中的中间状态。 如果长时间处于该状态，则说明出现异常，需要联系运营管理员处理。 SHUTOFF 运行中 稳定状态 裸金属服务器正常运行中的状态。 在这个状态的服务器可以运行您的业务。 ACTIVE 正在关机 中间状态 裸金属服务器从运行中到关机的中间状态。 如果长时间处于该状态，则说明出现异常，需要联系运营管理员处理。 ACTIVE 关机 稳定状态 裸金属服务器被正常停止。 在这个状态下的服务器，不能对外提供业务。 SHUTOFF 重启中 中间状态 裸金属服务器正在进行重启操作。 如果长时间处于该状态，则说明出现异常，需要联系运营管理员处理。 REBOOT 强制重启中 中间状态 裸金属服务器正在进行强制重启操作。 HARD_REBOOT 删除中 中间状态 裸金属服务器处于正在被删除的状态。 如果长时间处于该状态，则说明出现异常，需要联系运营管理员处理。 ACTIVE/SHUTOFF/REBOOT/HARD_REBOOT/ERROR 已删除 中间状态 裸金属服务器已被正常删除。在该状态下的服务器，不能对外提供业务，并在短时间内从系统中彻底清除。 DELETED 故障 稳定状态 裸金属服务器处于异常状态。 在这个状态下的服务器，不能对外提供业务，需要联系运营管理员进行处理。 ERROR 重建中 中间状态 裸金属服务器接收到重建请求，处于重建的过程中。 SHUTOFF 重装操作系统中 中间状态 裸金属服务器接收到重装操作系统请求，处于重装操作系统的过程中。 SHUTOFF 重装操作系统失败 稳定状态 接收到重装操作系统请求，进行重装的过程中发生异常，导致重装失败。 在这个状态下的服务器，不能对外提供业务，需要联系运营管理员进行处理。 SHUTOFF 锁定 中间状态/稳定状态 状态栏显示，表示裸金属服务器被锁定，处于保护状态。此时，部分操作将会被禁用，具体请以界面提示为准。 您可以点击锁图标下方的超链接，查看加锁资源。 - 父主题： 实例

包年/包月资源的使用建议 如果包年/包月裸金属服务器到期后，您不再继续使用该服务器，则可以登录管理控制台释放资源。释放资源的方法请参见“如何释放资源”。 对于以下常见的包年/包月裸金属服务器的使用场景，您可以参考我们提供的建议开通自动续费、设置统一到期日等功能，并关注资源到期、冻结等相关通知信息，以便及时了解资源情况，确保您的业务和数据不受影响。 表2 常见使用场景建议 常见使用场景 使用建议 包年/包月资源 及时手动续费 手动续费的方法请参见“如何手动续费”。 开通自动续费，并确保账户余额充足 开通自动续费的方法请参见“如何自动续费”。 关注自动续费失败的通知，及时为账户充值 关注资源即将到期的通知，及时续费 关注资源即将冻结的通知，及时续费 关注资源即将释放的通知，及时续费 包年/包月裸金属服务器挂载包年/包月磁盘 裸金属服务器的到期时间与磁盘不同 设置统一到期日，到期前对包年/包月裸金属服务器，以及磁盘批量续费，并选择统一到期日 设置统一到期日的方法请参见“如何设置统一到期日”。 批量续费的方法请参见“如何手动续费”。 包年/包月裸金属服务器挂载按需计费磁盘 将磁盘的计费模式由按需计费转为包年/包月 按需变更为包周期的方法请参见“按需变更为包周期”。

包年/包月资源的保留期介绍 “包年/包月”计费模式属于预付费，即您已提前支付资源的费用，例如购买包年/包月的裸金属服务器。 包年/包月资源到期前，若您未主动续费或者虽然开通了自动续费但自动续费失败，则到期后资源会被冻结，并且进入保留期。 保留期到期前，若您主动续费，则资源会被解冻。 保留期到期前，若您未主动续费，则保留期结束后资源会被释放。 保留期的时长会根据客户的等级有所不同，若您需要了解保留期的更多信息，请参见“保留期用户指南”。 图1 包年/包月资源到期前后的影响

各使用周期内的资源状态 裸金属服务器在正常使用周期内和超期未续费时，控制台上资源列表中的“状态”、“计费模式”会显示不同信息，在此进行统一说明。 表1仅描述裸金属服务器正常使用时的自然状态，排除手动上下电、故障等状态。 表1 各使用周期内的资源状态 使用周期 状态 计费模式 正常使用周期内 运行中 包年/包月 剩余xx天到期 超期未续费，进入保留期 冻结 包年/包月 已冻结，xx天后删除 超期未续费，已过保留期 已删除 包年/包月 释放

裸金属服务器与其他服务的关系 表1 裸金属服务器与其他服务的关系 服务名称 裸金属服务器与其他服务的关系 主要交互功能/最佳实践 镜像服务 （Image Management Service，IMS） 您可以通过镜像创建裸金属服务器，提高裸金属服务器的部署效率；也可以将裸金属服务器转换为私有镜像，供您个人使用，或者共享给他人。 通过私有镜像创建裸金属服务器 通过裸金属服务器创建私有镜像 通过外部镜像文件创建私有镜像 虚拟私有云（Virtual Private Cloud，VPC） 为裸金属服务器提供一个逻辑上完全隔离的专有网络，您可以在VPC中定义安全组、VPN、IP地址段、带宽等网络特性。用户可以通过VPC方便地管理、配置内部网络，进行安全、快捷的网络变更。同时，用户可以自定义安全组内与组间裸金属服务器的访问规则，加强裸金属服务器的安全保护。 添加安全组规则 绑定弹性公网IP至服务器 专属云（Dedicated Cloud，DeC） 专属云中的专属资源池与公共资源池物理隔离，如果您的业务对安全合规性有较高要求，那么您可以选择将裸金属服务器创建在专属云中。创建专属裸金属服务器有两种方式： 在专属云控制台创建专属裸金属服务器。 在云服务器控制台创建专属裸金属服务器。 开通专属云 创建专属裸金属服务器 云硬盘（Elastic Volume Service，EVS） 可以将云硬盘挂载至裸金属服务器，并可以随时扩容云硬盘容量。 挂载数据盘 初始化数据盘 卸载数据盘 扩容磁盘 专属企业存储服务（Dedicated Enterprise Storage Service，DESS） 如果您希望拥有独享、稳定时延的存储设备，以支撑Oracle RAC，SAP HANA TDI等关键应用，那么您可以在开通专属计算集群后申请专属企业存储，该存储采用华为OceanStor企业存储设备，为专属计算集群内的裸金属服务器提供块存储资源。 申请专属企业存储 创建磁盘 挂载磁盘 专属分布式存储服务（Dedicated Distributed Storage Service，DSS） 专属分布式存储服务为您提供独享的物理存储资源，通过数据冗余和缓存加速等多项技术，提供高可用性和持久性，以及稳定的低时延性能，适用于HPC、OLAP以及混合负载等应用场景。 磁盘类型概述 云服务器备份（Cloud Server Backup Service， CS BS） 云服务器备份提供对服务器的备份保护，支持基于多块云硬盘一致性快照技术的备份服务，并支持利用备份数据恢复服务器数据，最大限度保障用户数据的安全性和正确性，确保业务安全。 备份裸金属服务器 云监控服务 （Cloud Eye） 当您申请裸金属服务器后，安装Agent插件并完成相关配置，即可在 云监控 服务查看裸金属服务器的监控数据，还可以获取可视化监控图表。 主机监控概述 支持的监控指标 云审计 服务（Cloud Trace Service， CTS ） 通过云审计服务，您可以记录与裸金属服务器相关的操作事件，便于日后的查询、审计和回溯。 查看审计日志 支持审计的关键操作列表 标签管理服务（Tag Management Service，TMS） 使用标签来标识裸金属服务器，便于分类和搜索。 添加标签 使用标签检索资源 删除标签

云硬盘类型 裸金属服务器使用的云硬盘类型有如下几种： 普通IO（上一代产品）：该类型云硬盘的最大IOPS为2200，适用于大容量、读写速率中等、事务性处理较少的应用场景，例如企业的日常办公应用或者小型测试等。 高IO：该类型云硬盘的最大IOPS可达5000，最低读写时延为1ms，适用于主流的高性能、高可靠应用场景，例如企业应用、大型开发测试以及Web服务器日志等。 超高IO：该类型云硬盘的最大IOPS可达33000，最低读写时延为1ms，适用于超高IO，超大带宽的读写密集型应用场景，例如高性能计算应用场景，用来部署分布式文件系统，或者I/O密集型应用场景，用来部署各类NoSQL/关系型数据库。 通用型SSD：该类型云硬盘的最大IOPS可达20000，最低读写时延为1ms，适用于各种主流的高性能、低延迟交互应用场景，例如企业办公、大型开发测试、转码类业务、Web服务器日志以及容器等高性能系统盘。 极速型SSD：该类型云硬盘的最大IOPS可达128000，最低读写时延为亚毫秒级，采用了结合全新低时延拥塞控制算法的RDMA技术，适用于需要超大带宽和超低时延的应用场景。 当前physical.d2.large和physical.io2.xlarge规格为本地存储型（大数据）机型，不支持挂载云硬盘。

云硬盘的磁盘模式 裸金属服务器当前仅支持SCSI（小型计算机系统接口，Small Computer System Interface）磁盘模式的云硬盘。 您可以通过管理控制台创建SCSI类型的云硬盘，该类型的云硬盘支持SCSI指令透传，允许裸金属服务器操作系统直接访问底层存储介质。除了简单的SCSI读写命令，SCSI类型的云硬盘还可以支持更高级的SCSI命令。 裸金属服务器公共镜像的操作系统中已经预安装了使用SCSI类型云硬盘所需的驱动，无需再安装。您也可以参考《裸金属服务器私有镜像制作指南》的“安装SDI卡驱动”章节了解驱动安装的详细操作。

如何选择区域？ 选择区域时，您需要考虑以下几个因素： 地理位置 一般情况下，建议就近选择靠近您或者您的目标用户的区域，这样可以减少网络时延，提高访问速度。 在除中国大陆以外的亚太地区有业务的用户，可以选择“中国-香港”、“亚太-曼谷”或“亚太-新加坡”区域。 在非洲地区有业务的用户，可以选择“非洲-约翰内斯堡”区域。 在拉丁美洲地区有业务的用户，可以选择“拉美-圣地亚哥”区域。 “拉美-圣地亚哥”区域位于智利。 资源的价格 不同区域的资源价格可能有差异，请参见华为云服务价格详情。

什么是区域、可用区？ 区域和可用区用来描述数据中心的位置，您可以在特定的区域、可用区创建资源。 区域（Region）：从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 可用区（AZ，Availability Zone）：一个AZ是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 图1阐明了区域和可用区之间的关系。 图1 区域和可用区 目前，华为云已在全球多个地域开放云服务，您可以根据需求选择适合自己的区域和可用区。更多信息请参见华为云全球站点。

实例类型 裸金属服务器按着CPU体系架构，分为x86和鲲鹏实例，物理资源池配备华为自研高性能物理服务器，搭配独家调优算法，为您提供可靠的硬件环境。您可以根据业务需求选购不同配置的裸金属服务器。 x86 V4实例（CPU采用Intel Broadwell架构）（停止扩容） x86 V5实例（CPU采用Intel Skylake架构）（停止扩容） x86 V6实例（CPU采用Intel Cascade Lake架构） 鲲鹏 V1实例（CPU采用Huawei Kunpeng 920架构）

公共镜像 公共镜像是由华为云官方提供的镜像，适配了裸金属服务器兼容性并安装了必要的初始化插件，所有用户均可使用，涵盖大部分主流操作系统。裸金属服务器规格不同，可供选择的镜像会有所不同（参见裸金属服务器类型与支持的操作系统版本）。 公共镜像特点 操作系统类型：基于Linux的系统，并定期更新维护。 软件支持：集成了一些裸金属服务器的存储、网络以及用户基本功能正常使用所依赖的相关插件。 这些插件为裸金属服务器功能保障的基本插件，请勿做删除或者修改操作，否则会影响您的基本功能使用。 表2 软件支持 软件 描述 Cloud-init Cloud-init是开源的云初始化程序，能够对新创建裸金属服务器中指定的自定义信息（主机名、密钥和用户数据等）进行初始化配置。 一键式重置密码插件 裸金属服务器提供了一键式重置密码功能，当系统密码丢失或过期时，如果您的裸金属服务器提前安装了密码重置插件，可以在控制台页面设置新密码。 bms-network-config网络配置插件 网络初始化插件主要用于裸金属服务器下发过程网络的自动化配置以及用户误操作导致网络中断场景下裸金属服务器网络恢复。 该插件位于“/opt/huawei”目录下，请勿删除和改动。 SDI卡前端驱动插件 镜像中安装SDI卡前端驱动插件，使裸金属服务器能够支持挂载云硬盘，并且支持从云硬盘启动，实现快速发放能力。 兼容适配：对服务器硬件做了兼容适配。 安全性：公共镜像具有高度稳定性，并且为正版授权。 限制：暂无使用限制。

私有镜像 包含操作系统、预装的公共应用以及用户的私有应用。选择私有镜像创建裸金属服务器，可以节省您重复配置裸金属服务器的时间。 私有镜像特点 兼容适配：只适配了用于导出镜像的同型号服务器，不能保证能正确部署其他型号的裸金属服务器。 功能支持：支持用户自由创建和删除私有镜像，并使用私有镜像部署和重装服务器。私有镜像还支持以下操作： 不同账号之间共享镜像。 不同区域之间复制镜像。 导出镜像至个人OBS桶。 限制：每个用户最多创建50个私有镜像。 费用：私有镜像会收取一定的存储费用。详细计费标准可参考镜像的计费标准。

产品架构 通过和其他服务组合，裸金属服务器可以实现计算、存储、网络、镜像安装等功能： 裸金属服务器在不同可用区中部署（可用区之间通过内网连接），部分可用区发生故障后不会影响同一区域内的其他可用区。 可以通过虚拟私有云（Virtual Private Cloud，VPC）建立专属的网络环境，设置子网、安全组，并通过弹性公网IP实现外网链接（需带宽支持）。 通过镜像服务，可以对裸金属服务器安装镜像，也可以通过私有镜像批量创建裸金属服务器，实现快速的业务部署。 通过云硬盘服务实现数据存储，并通过云硬盘备份服务实现数据的备份和恢复。 云监控是保持裸金属服务器可靠性、可用性和性能的重要部分，通过云监控，用户可以观察裸金属服务器资源。 云备份提供对云硬盘和裸金属服务器的备份保护服务，支持基于快照技术的备份服务，并支持利用备份数据恢复服务器和磁盘的数据。 图1 BMS产品架构

裸金属服务器与物理机、虚拟机的功能对比 裸金属服务器与物理机、虚拟机的对比如表1所示。其中，Y表示支持，N表示不支持，N/A表示不涉及。 无特性损失、无性能损失：裸金属服务器具备物理机的一切特性和优势，您的应用可以直接访问裸金属服务器的处理器和内存，无任何虚拟化开销。 表1 特性对比 功能分类 功能 裸金属服务器 物理机 虚拟机 下发方式 自动化发放 Y N Y 计算 无特性损失 Y Y N 无性能损失 Y Y N 资源无争抢 Y Y N 存储 拥有本地存储 Y Y N 使用云硬盘（系统盘）启动 Y N Y 使用镜像，免操作系统安装 Y N Y 网络 使用虚拟私有云网络 Y N Y 物理机集群和虚拟机集群之间通过VPC通信 Y N Y 管控 远程登录等用户体验和虚拟机一致 Y N Y 支持监控以及关键操作审计 Y N Y

常用概念 云上的物理计算资源，即运行在华为云数据中心的裸金属服务器，请查看实例。 描述裸金属服务器所在的数据中心，请查看区域和可用区。 裸金属服务器由不同的CPU、内存、存储和网络等组成，请查看实例类型。 裸金属服务器运行环境的模板，其中包含了特定的操作系统和一些预装的应用软件，请查看镜像。 裸金属服务器网络类型及各自使用场景，请查看网络。 实例对内和对外的服务地址，即私有IP地址和弹性公网IP地址。

裸金属服务器介绍 裸金属服务（Bare Metal Server，BMS）是一款兼具弹性云服务器和物理机性能的计算类服务，为您和您的企业提供专属的云上物理服务器，为核心数据库、关键应用系统、高性能计算、大数据等业务提供卓越的计算性能以及数据安全。租户可灵活申请，按需使用。 裸金属服务器的开通是自助完成的，您只需要指定具体的服务器类型、镜像、所需要的网络配置等，即可在30min内获得所需的裸金属服务器。服务器供应、运维工作交由华为云，您可以专注于业务创新。

请求示例 迁移备份资源从源存储库到目标存储库且不删除源备份。 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" }

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

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

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

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

请求示例 执行存储库资源自动备份，生成备份还原点。 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" } }

请求参数 表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。仅在多盘备份特性中有效，排除不需要备份的磁盘。当虚拟机新绑定磁盘时，也能继续排除之前设置不用备份的卷。

响应参数 状态码：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 备份保留天数

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

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

响应参数 状态码：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可能无法使用。

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