华为云用户手册

base资源目录结构 代码结构说明中的“{biz}”，为在AstroPro的业务设计中定义的对象，如BO、Abstract BO等。 resources # 资源目录结构 |-- mapper # 开源组件mybatis的mapper.xml文件存放目录 {biz}Mapper.xml # 该目录下的文件禁止用户改动

resources目录结构说明 代码结构说明中的“{biz}”，为在AstroPro的业务设计中定义的对象，如BO、Abstract BO等。 resources |-- mapper # 开源组件mybatis的mapper.xml文件存放目录 |-- base # 该目录下的文件禁止用户改动 {biz}BaseMapper.xml {biz}Mapper.xml # 只在初次代码生成，用户可在此文件中实现自定义的方法 |-- openapi # swagger.yaml存放目录 swagger.yaml # swagger.yaml文件 application.yml # SpringBoot全局配置文件 banner.txt # 应用程序的banner文件 log4j2.xml # log4j2日志配置文件 metadata.json # 元数据配置文件

代码结构说明 代码结构说明中的“{biz}”，为在AstroPro的业务设计中定义的对象，如BO、Abstract BO等。 com.astropro |-- api # API层代码，定义向外部服务暴露的接口（必填项） {biz}Api.java {biz}Controller.java |-- service # 承接API直接调用，基本的业务判断逻辑和分发。service层目录，包含接口层和实现层 (必须) |-- impl # service实现代码（必填项） |-- {biz}Service.java I{biz}Service.java # service接口层代码。 |-- domain # 领域层，包含基本的业务和业务聚合（必填项） {biz}Domain.java |-- repository # 数据操作聚合层。包含基类和继承类 （必填项） |-- base # 数据操作聚合层基类代码（必填项） {biz}BaseRepository.java {biz}Repository.java # 数据操作聚合层继承类代码。用户可在此类中覆写基类中的方法或者增加自定义的方法 |-- mapper # 数据原子操作层。mapper层目录，包含基本接口和继承接口（必填项） |-- base # mapper层基本接口代码（必填项） {biz}BaseMapper.java {biz}Mapper.java # mapper层继承接口代码。用户可在此类中覆写基本接口中的方法或者增加自定义的方法 |-- model |-- entity # 实体类（必填项） |-- enums # 枚举类（可选项） |-- qo # 查询对象（可选项） |-- criteria # mybatis查询条件对象（可选项） |-- dto # 数据传输对象，do组合对象（可选项） |-- nested # 根据业务对象的关系自动关联生成，嵌套复杂对象（可选项） |-- cartesian # 根据业务对象的关系自动关联生成，正交的笛卡尔积对象（可选项） |-- {customDto}.java # 用户预先定义好的数据传输对象（可选项） |-- config # 配置类（必填项） |-- utils # 工具类（必填项） |-- exception # 异常类（必填项） |-- integration # 集成第三方服务，隔离外部系统的影响，起防腐作用（可选项） |-- event # 事件层（可选项） |-- publish # 发布事件的Package，存放事件发布的工具类 与 发布的事件对象，屏蔽技术组件对应用业务的侵入 |-- subscribe # 订阅事件的Package，存放listener与消费的事件对象，listener只做数据的监听与数据格式的转换

关系属性设置 在业务设计页面，拖入一个BO业务对象和一个Abstract BO对象（命名为Role、Abstract），单击“relations”中的“继承”，为对象建立继承关系。选中已创建的关系，在右侧页面即可设置关系属性，如图3所示。 图3 继承关系 关系名称：设置继承关系的名称。 关系类型：根据创建的继承关系自动生成。 关系首要方：根据创建的继承关系自动生成。 关系次要方：根据创建的继承关系自动生成。

关系属性设置 在业务设计页面，拖入一个BO业务对象（命名为Bo5）单击“relations”中的“树递归”，为对象建立树递归关系。选中已创建的关系，在右侧页面即可设置关系属性，如图2所示。 图2 树递归 关系名称：设置树递归关系的名称。 关系类型：根据创建的树递归关系自动生成。 关系首要方：根据创建的树递归关系自动生成。 关系次要方：根据创建的树递归关系自动生成。 关系操作：对象关系可执行哪些操作，如新增、删除、查询、批量新增、批量删除和批量查询。 每个Bo5可以包含多少个子Bo5：一个首要方（父节点）和次要方（子节点）建立关联的数量上限。 每个父节点能有多少子节点上限预警值：首要方（父节点）一条数据最多关联次要方（子节点）多少条数据报出告警。

关系属性设置 在业务设计页面，拖入两个BO业务对象（命名为Bo1、Bo2）单击“relations”中的“聚合”，为对象建立聚合关系。选中已创建的关系，在右侧页面即可设置关系属性，如图2所示。 图2 聚合 关系名称：设置聚合关系的名称。 关系类型：根据创建的聚合关系自动生成。 关系首要方：根据创建的聚合关系自动生成。 关系次要方：根据创建的聚合关系自动生成。 DTO暴露方式 - NESTED：是否设置DTO的NESTED（嵌套）能力。默认为生成DTO读写API。 不设置：不生成NESTED。 只生成DTO：只生成NESTED对象的类。 生成DTO读API：只会生成一个get接口。 生成DTO读写API：除了生成一个get接口，还会生成一个插入接口。 DTO暴露方式 - CARTESIAN：设置DTO的CARTESIAN（笛卡尔积）能力。 不设置：不生成CARTESIAN。 只生成DTO：只生成CARTESIAN对象的类。 生成DTO读API：只会生成一个get接口。 每个Bo1关联最大Bo2数：一个首要方和次要方建立关联的数量上限。 每个Bo1最大关联Bo2数：一个次要方和首要方建立关联的数量上限。 每个Bo1关联最大Bo2维度上限预警值：首要方一条数据最多关联次要方多少条数据报出告警。

关系属性设置 在业务设计页面，拖入两个BO业务对象（命名为Bo3、Bo4），单击“relations”中的“多对多”，为对象建立多对多关系。选中已创建的关系，在右侧页面即可设置关系属性，如图2所示。 图2 多对多关系 关系名称：设置多对多关系的名称。 关系类型：根据创建的多对多关系自动生成。 关系首要方：根据创建的多对多关系自动生成。 关系次要方：根据创建的多对多关系自动生成。 表名：设置关系表的名称，请按需自定义。在多对多关系中，会建立关系表用来保存首要方和次要方id的关系。 DTO暴露方式 - NESTED：是否设置DTO的NESTED（嵌套）能力。默认为不设置。 不设置：不生成NESTED。 只生成DTO：只生成NESTED对象的类。 生成DTO读API：只会生成一个get接口。 生成DTO读写API：除了生成一个get接口，还会生成一个插入接口。 DTO暴露方式 - CARTESIAN：设置DTO的CARTESIAN（笛卡尔积）能力。 不设置：不生成CARTESIAN。 只生成DTO：只生成CARTESIAN对象的类。 生成DTO读API：只会生成一个get接口。 关系操作：对象关系可执行哪些操作，如新增、删除、查询、批量新增、批量删除和批量查询。 每个Bo3关联最大Bo4数：一个首要方和次要方建立关联的数量上限。 每个Bo4关联最大Bo3数：一个次要方和首要方建立关联的数量上限。 每个Bo3关联最大Bo4维度上限预警值：首要方一条数据最多关联次要方多少条数据报出告警。 每个Bo4最大关联Bo3维度上限预警值：次要方一条数据最多关联首要方多少条数据报出告警 编辑字段：多对多的关系是通过一个关系表来表示的。单击“编辑字段”，可为关系表添加字段。

关系属性设置 在业务设计页面，拖入两个BO业务对象（命名为Primary、Secondary），单击“relations”中的“一对多”，为对象建立一对多关系。选中已创建的关系，在右侧页面即可设置关系属性，如图2所示。 图2 一对多关系 关系名称：设置一对多关系的名称。 关系类型：根据创建的一对多关系自动生成。 关系首要方：根据创建的一对多关系自动生成。 关系次要方：根据创建的一对多关系自动生成。 DTO暴露方式 - NESTED：是否设置DTO的NESTED（嵌套）能力。默认为不设置。 不设置：不生成NESTED。 只生成DTO：只生成NESTED对象的类。 生成DTO读API：只会生成一个get接口。 生成DTO读写API：除了生成一个get接口，还会生成一个插入接口。 DTO暴露方式 - CARTESIAN：设置DTO的CARTESIAN（笛卡尔积）能力。 不设置：不生成CARTESIAN。 只生成DTO：只生成CARTESIAN对象的类。 生成DTO读API：只会生成一个get接口。 每个Primary关联最大Secondary数：一个首要方和次要方建立关联的数量上限。 每个Secondary最大关联Primary数：一个次要方和首要方建立关联的数量上限。 每个Primary关联最大Secondary维度上限预警值：首要方一条数据最多关联次要方多少条数据报出告警。

步骤5：服务依赖 通常情况下，一个应用不是一个单独的服务，可能由多个服务共同组成。这些服务之间可能存在一些跨服务的调用，此时就需要通过添加依赖服务，把这些服务的客户端集成过来。添加依赖服务前，请确保依赖服务的“是否生成客户端”按钮已启用。 图1 开启“是否生成客户端”配置 在服务依赖中，选择当前服务依赖的服务。 图2 选择依赖的服务 选择依赖服务的版本号。 在依赖强弱中，选择strong（强）或weak（弱），单击“添加”，完成依赖服务的添加。 图3 完成依赖服务的添加 选择客户端的依赖类型，支持“SDK”和“METHOD”两种类型，可按需选择。 （可选）添加客户端流控策略。 选择SDK类型时，无须配置流控策略。 选择“METHOD”类型后，单击“编辑”，可为对象方法配置流控策略。例如：为User对象的addOder添加一个Retry的流控策略，如图4所示。 您可以选择系统预置的流控策略，也可以选择自定义流控策略。选择自定义流控策略需提前在资产库中创建客户端流控策略。 单击“保存”，完成流控策略配置。 图4 为对象添加方法的流控策略 父主题： 编辑服务

步骤4：业务设计 步骤1：基本配置、步骤2：框架配置和步骤3：生成策略中参数，只需要用户根据自身业务直接在界面进行勾选配置。而业务设计需要用户根据实际的需求，进行业务模型的设计和配置。 例如，创建一个简单的订单系统，订单系统中包括用户（User）、订单（Order）和订单详情（OrderDetail）三个业务对象，且三个对象之间存在聚合关系，即用户存在时，订单才会存在，订单存在时，订单详情才会存在。同时一个用户可以关联多个订单，订单通过单号进行标识，一个订单又可以关联多个商品，例如手机、耳机等，商品可以记录数量。实现上述业务逻辑，需要进行如下设计： 在业务设计页面，拖拽所需的对象到设计区，并修改对象名称。 AstroPro提供了BO、Abstract BO和Value Object三种类型的对象，请根据业务需求进行选择。 BO：业务对象，业务对象映射到服务中的一个实体，对应数据库中的一张表。 Abstract BO：抽象对象，不能实例化，没有对应的数据库表，需要和业务对象有个继承的操作。例如，业务对象A继承一个抽象对象B，则B中的字段都会被A继承过来。 Value Object：值对象，不能单独存在，需要和业务对象建立聚合的关系。 本示例中，拖拽三个BO对象到设计区，选中对应的BO，修改对象名称为User、Order和OrderDetail。 图1 拖拽三个BO到设计区 设置对象属性。 本示例中，因为一个用户需要关联多个订单，订单通过单号进行标识，一个订单又可以关联多个商品，商品可以记录数量。所以需要为“User”添加“name（用户名）”字段，用于记录用户信息。为“Order”添加“orderNo（订单编号）”字段，用于记录订单的编号。为“OrderDetail”添加“product（商品）”、“amount（数量，integer类型）”字段，分别用于记录商品的详情和商品的数量。 图2 为User对象添加name 图3 为Order添加orderNo 图4 OrderDetail添加product和amount 建立对象之间的关系。 AstroPro提供了一对多、多对多、聚合、树递归和继承五大关系，请根据自身业务需求进行选择。各对象间关系详细介绍，请参见对象间关系。 本示例中的订单系统，当用户存在时，订单才会存在，订单存在时，订单详情才会存在，此时需要为三个对象之间建立聚合关系。聚合关系中，次要方必须依赖首要方，任何对于次要方的操作首先要经过首要方才能继续往下操作。在User和Order的聚合关系中，User为首要方，Order为次要方，即用户存在时，订单才会存在。在Order和OrderDetail的聚合关系中，Order为首要方，OrderDetail为次要方，即订单存在时，订单详情才会存在。 图5 设置对象间关系 设置完成后，单击“下一步”，进行服务依赖设置。 父主题： 编辑服务

了解服务创建流程 在AstroPro中创建一个服务的流程，如图1所示。 图1 创建服务流程图 新增一个服务 创建一个空服务，并指定服务的版本。创建服务前，请确保已创建项目和服务组。 基本配置 设置服务框架、版本和单元化策略等信息，请根据实际业务直接在界面进行勾选。 框架配置 设置服务的架构、数据库、缓存和安全认证等信息，请根据实际业务直接在界面进行勾选。 生成策略 设置服务的API、代码风格、部署和性能测试等信息，请根据实际业务直接在界面进行勾选。 业务设计 基本配置、框架配置和生成策略需要用户根据自身业务的实际情况进行配置，配置不同生成的效果有所不同。业务设计是AstroPro的核心能力，是用户设计自己业务的基础。 服务依赖 通常情况下，一个应用不是一个单独的服务，可能由多个服务共同组成。这些服务之间可能存在一些跨服务的调用，此时就需要通过添加依赖服务，把这些服务的客户端集成过来。 生成服务代码 根据配置的业务模型，生成服务的代码。

了解构建流程 在AstroPro中，用户通过业务建模，可生成高可用、高可靠、以及安全稳定的企业级IT应用框架。业务建模是指通过业务设计，将实际业务涉及的对象和行为转换为元数据中的对象、对象关系、服务依赖等构成的模型，通过模型生成服务，实现业务需求。 使用AstroPro创建企业核心应用的流程，如图1所示。 图1 创建企业核心应用流程图 创建项目 项目是使用AstroPro核心业务的入口。在使用AstroPro前，需要先创建一个项目。 创建服务组 服务组用于对项目中的服务进行分组，一般一个分组对应一个研发团队。创建项目后，默认会创建一个和项目同名的服务组，所有新建服务默认在此分组下。 添加服务 在新增服务界面，通过简单的配置，完成服务框架的搭建。 编辑服务 添加服务的操作，相当于为服务搭建了一个框架。如果需要服务实现某些特定的功能，还需要您根据业务需求，对服务进行业务模型配置。 生成服务代码 基于配置的业务模型，生成服务的基本代码。代码生成后，会提供一个压缩包，供您直接使用。 父主题： 创建企业核心应用

使用说明 在使用AstroPro前，您需要购买一个AstroPro实例。AstroPro实例是一个独立的资源空间，所有的操作都是在实例内进行，不同实例间的资源相互隔离。 相对于基础版实例，专业版实例提供了更多的应用及实体功能，可满足中大型企业的复杂管理需求。除此之外，购买专业版实例时或购买实例后，支持对资源进行扩容。专业版和基础版实例支持的特性差异，请参见产品规格差异。为了便于您更好的了解AstroPro，本指南中操作及截图均以专业版实例为例进行介绍。

购买扩容包 扩容包仅适用于在购买专业版的基础上使用，不可单独购买和退订。扩容包的使用截止时间与主资源的截止时间保持一致。 参考购买实例中操作，购买AstroPro专业版实例。 在已购买的实例中，单击“操作”，选择“扩容”。 图4 选择扩容 在购买扩容包页面，设置购买数量，单击“立即购买”。 一个资源扩容包，包含用户数50个、应用数20个、实体个数200个，请按需设置购买数量。 图5 购买扩容包 选择支付方式，单击“确认付款”，完成订单支付。 返回AstroPro服务控制台，在已购买的实例中，单击“进入首页”，查看扩容后的资源规格。 图6 查看扩容后规格

购买实例 进入购买Astro企业应用实例页面。 “实例规格”选择“专业版”，其他参数按需进行设置，单击“立即购买”。 图1 选择购买规格 确认订单无误后，单击“去支付”。 以购买专业版一年为例，若为基础版，此处配置费用为“0”。 图2 确认订单 选择支付方式，单击“确认付款”，完成支付。 订单支付成功后，单击“返回Astro企业应用控制台”。 在Astro企业应用控制台中，可以查看到Astro企业应用的实例状态。当“实例状态”变为“运行中”时，说明实例已安装完成，可以正常使用Astro企业应用。 图3 查看实例状态

3、了解AstroPro中的项目、服务组与服务之间的关系 项目是使用AstroPro核心业务的入口。服务组用于对项目中的服务进行分组，一般一个分组对应一个研发团队。服务组创建后，即可为项目添加服务。服务是业务概念，即提供某种服务的某个进程。每一个服务都具有自主运行的业务功能，对外开放不受语言限制的API，多个服务组成应用程序。 在AstroPro中，项目、服务组和服务之间的关系，如图1所示。 图1 项目、服务组与服务的关系

4、熟悉如何进行业务设计 在AstroPro中，用户通过业务设计，可生成高可用、高可靠、以及安全稳定的企业级IT应用框架。 对象：对象可以理解为数据库中创建的一个表。每个对象对应一张数据库表，用于保存业务系统需要的配置数据和业务数据。对象可以存储组织或业务特有的数据，您可以围绕对象这一核心，定义相关的字段、字段校验规则、界面样式、字段变更时的触发事件等。如果把待开发的业务系统比作一部电影，对象就是电影中的各个角色，需要勾勒角色的外貌、性格特点、人物关系和所经历的剧情。 AstroPro提供了BO、Abstract BO和Value Object三种类型的对象，请根据业务需求进行选择。 BO：业务对象，业务对象映射到服务中的一个实体，对应数据库中的一张表。 Abstract BO：抽象对象，不能实例化，没有对应的数据库表，需要和业务对象有个继承的操作。例如，业务对象A继承一个抽象对象B，则B中的字段都会被A继承过来。 Value Object：值对象，不能单独存在，需要和业务对象建立聚合的关系。 对象间关系：关系描述了不同元素之间的关联和联系，在AstroPro中您可以定义一对多、多对多、聚合和继承等关系。

AstroPro权限 默认情况下，新建的 IAM 用户没有任何权限，需要将其加入用户组，并给用户组授予策略或角色，才能使得用户组中的用户获得对应的权限，这一过程称为授权。授权后，用户就可以基于被授予的权限对云服务进行操作。 AstroPro部署时通过物理区域划分，为项目级服务。授权时，“作用范围”需要选择“区域级项目”，然后在指定区域（如华北-北京4）对应的项目（cn-north-4）中设置相关权限，并且该权限仅对此项目生效。如果在“所有项目”中设置权限，则该权限在所有区域项目中都生效。访问AstroPro时，需要先切换至授权区域。 根据授权精细程度分为角色和策略。 角色：IAM最初提供的一种根据用户的工作职能，定义权限的粗粒度授权机制。该机制以服务为粒度，提供有限的服务相关角色用于授权。由于华为云各服务之间存在业务依赖关系，因此给用户授予角色时，可能需要一并授予依赖的其他角色，才能正确完成业务。角色并不能满足用户对精细化授权的要求，无法完全达到企业对权限最小化的安全管控要求。 策略：IAM最新提供的一种细粒度授权的能力，可以精确到具体服务的操作、资源以及请求条件等。基于策略的授权是一种更加灵活的授权方式，能够满足企业对权限最小化的安全管控要求。 如表1所示，包括了AstroPro的所有系统权限。 表1 AstroPro系统权限 策略名称 描述 类别 策略内容 Astro Pro FullAccess Astro企业应用的管理员权限，拥有该权限的用户可以使用服务的所有功能。 系统策略 Astro Pro FullAccess策略内容 Astro Pro InstanceManagement Astro企业应用的实例管理权限，拥有该权限的用户可以创建和管理实例。 系统策略 Astro Pro InstanceManagement策略内容 表2列出了AstroPro常用操作与系统策略的授权关系，您可以参照该表选择合适的系统策略。 表2 AstroPro操作与系统策略关系 操作 Astro Pro FullAccess Astro Pro InstanceManagement 查询商品可售卖周期 √ √ 查询订单信息 √ √ 订购询价 √ √ 查询实例信息 √ √ 变更询价 √ √ 云服务到期查询 √ √ 购买实例 √ √ 购买扩容包 √ √ 实例升级 √ √ 实例冻结 √ √ 实例解冻 √ √ 删除实例 √ √

Astro Pro InstanceManagement策略内容 { "Version": "1.1", "Statement": [ { "Action": [ "astropro:instance:*" ], "Effect": "Allow" } ] }

新服务构建 应用场景 应用场景复杂，缺乏软件架构设计能力，以及微服务开发能力。 开发能力不足，缺乏编码规范和安全编码意识。 对云上数据库、中间件和存储等服务不了解，缺乏云上服务对接能力。 价值 根据用户的诉求，快速帮助用户生成满足DDD领域驱动设计的框架代码，并且内置稳定的安全防护能力和编码规范、API规范、数据规范，极大提升了用户开发效率和开发代码质量。 优势 生成满足DDD领域驱动设计的框架代码，开发人员更加专注于业务问题的解决，提高代码质量和开发效率，并且更好地支持不断演化的业务需求。 内置稳定的安全防护能力和编码规范、API规范、数据规范，极大提升了开发代码质量。 内置云服务对接能力，快速对接多种云服务。

平台预置云服务中间件接入、服务治理、通用基础能力提供 提供框架级内置组件，可结合建模业务使用和单独使用。 中间件&高可用增强 内置中间件增强能力，如容灾切换、消息高可靠等，兼容开源解决方案。 云服务接入 内置云服务对接能力，零码完成云服务的对接，助力服务低成本达成云原生、应用现代化等目标。 服务治理能力 开源服务治理能力基础上增强依赖降级、可观测等易用性强能力，大幅提升企业应用可治理能力。 应用通用基础能力 提供标准通用基础能力，包括标准三方件及依赖管理可快速解决版本漏洞、安全特性及日志跟踪等能力。

什么是Astro企业应用 Astro企业应用（Astro Pro，简称AstroPro）是Astro面向企业数字化转型提供的元数据驱动的企业应用一站式构建平台。为企业SaaS应用提供端到端开发管理平台，沉淀通用能力，加快应用构建，差异场景灵活扩展，助力业务创新。AstroPro通过元数据多租，高低代码协同等能力，快速构建企业核心业务应用，提高多层级/多分支企业的应用构建效率。 图1 AstroPro总体架构图

请求示例 批量添加镜像标签，其中，标签键为“key1”对应的值为“value1”、标签键为“key2”对应的值为“value2”。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 POST https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/67e17426-359e-49fb-aa12-0bd1756ec240/tags/action { "tags": [{ "value": "value1", "key": "key1" }, { "value": "value2", "key": "key2" }, { "value": "", "key": "key3" }], "action": "create" } 批量删除镜像标签，其中，标签键为“key1”对应的值为“value1”、标签键为“key2”对应的值为“value2”。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 POST https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/67e17426-359e-49fb-aa12-0bd1756ec240/tags/action { "tags": [{ "value": "value1", "key": "key1" }, { "value": "value2", "key": "key2" }, { "value": "", "key": "key3" }], "action": "delete" }

约束与限制 每个标签由键值对组成，标签的key的长度不超过36个字符，value的长度不超过43个字符。key不能为空或者空白字符串，value不能为空，但可以是空白字符串。 单个镜像最多添加10个标签。 请求体中的多个标签的key不允许重复。 此接口为幂等接口： 创建时，如果创建的标签已经存在，即key相同而value不同，则更新对应标签；如果创建的标签已经存在，key/value均相同，则不进行重复添加，视为添加成功。 删除时，如果指定的标签不存在，则默认视为删除成功。 批量删除时对key、value的限制： 删除时，对标签的key、value不做字符集范围校验，key不允许为空或空白字符串；value为可选，且不对value做校验。如果要删除的标签不存在，视为删除成功，不报错。删除时，对标签的key、value做长度校验，标签的key不超过127，value不超过255。

请求消息 请求参数 参数 是否必选 参数类型 描述 tags 是 Array of objects 要操作的标签列表。详情请参见表2。 action 是 String 要进行的标签操作，区分大小写。支持create、delete，分别用于批量地创建/更新、删除标签。 表2 tags数据结构说明 参数 是否必选 参数类型 描述 key 是 String 标签的键，键不能为空。 value 是 String 标签的值。

API概览 镜像服务 所提供的接口分为IMS接口与OpenStack原生接口。推荐您使用IMS接口。 通过配合使用镜像服务提供的接口和OpenStack原生接口，您可以完整地使用镜像服务的所有功能。例如制作私有镜像，可以使用OpenStack原生接口，也可以使用IMS接口进行操作。 表1 接口说明 类型 子类型 说明 IMS接口 镜像 可以实现镜像的制作、镜像列表查询、镜像导出等操作。 镜像标签 对私有镜像进行自定义标记。通过镜像标签，用户可以自由地对私有镜像分类管理。 镜像共享 用户可以将私有镜像共享给其他用户使用。通过镜像共享的接口完成镜像共享的相关操作。 镜像复制 通过Region内复制镜像实现加密镜像与非加密镜像的转换；通过跨Region复制镜像实现镜像在两个区域间复制，帮助用户实现区域间的业务迁移。 镜像配额 查询租户在当前Region的私有镜像的配额数量。 镜像任务 查询异步任务接口执行情况以及异步任务进度。 OpenStack原生接口 镜像 可以实现镜像的制作、镜像列表/详情查询、镜像导出等操作。 镜像标签 对私有镜像进行自定义标记。通过镜像标签，用户可以自由地对私有镜像分类管理。 镜像视图 镜像视图是提供给用户查询镜像属性详情的接口，比如属性的取值类型、用途等。通过镜像视图，用户可以从宏观上对镜像的基本情况进行了解。 镜像共享 用户可以将私有镜像共享给其他用户使用。通过镜像共享的接口完成镜像共享的相关操作。 查询API版本信息 查询镜像服务当前所用的API版本。

响应消息 响应参数 参数 参数类型 描述 status String 镜像状态 virtual_size Integer 镜像虚拟大小 name String 镜像名称。name参数说明请参考镜像属性。 deleted Boolean 镜像是否已删除 container_format String 镜像容器类型 created_at String 镜像创建时间 disk_format String 镜像文件类型 updated_at String 镜像更新时间 properties Object 镜像属性 owner String 镜像所属租户 protected Boolean 镜像是否受保护 min_ram Integer 运行镜像所需最小内存，单位MB checksum String 镜像校验和，上传镜像文件后存在 min_disk Integer 运行镜像所需最小磁盘，单位GB is_public Boolean 是否为公共镜像 deleted_at String 镜像删除时间 id String 镜像UUID size Integer 镜像大小，上传镜像文件后存在 响应样例 HTTP/1.1 200 OK 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 Content-Type: application/json; charset=UTF-8 Content-Length: 495 X-Openstack-Request-Id: req-68327dda-8078-41fe-b091-01a09ec073da Date: Mon, 23 May 2016 02:32:28 GMT { "images": [ { "status": "active", "deleted_at": null, "name": "cirros", "deleted": false, "container_format": "bare", "created_at": "2016-05-22T06:04:20.425843", "disk_format": "qcow2", "updated_at": "2016-05-22T06:04:22.719791", "min_disk": 0, "protected": false, "id": "3c3d1d01-b48a-4639-8a88-08be3b9b5d78", "min_ram": 0, "checksum": "64d7c1cd2b6f60c92c14662941cb7913", "owner": "23f4cb75768d4febb39542ef6fe169f3", "is_public": true, "virtual_size": null, "properties": { }, "size": 13167616 } ] }

请求消息 请求参数 可以把name、container_format、disk_format、status、size_min、size_max、changes-since作为uri参数，过滤查询结果。 参数 是否必选 参数类型 描述 name 否 String 镜像名称。name参数说明请参考镜像属性。 container_format 否 String 镜像容器类型 disk_format 否 String 镜像文件格式 status 否 String 镜像状态 size_min 否 String 镜像不小于 size_max 否 String 镜像不大于 changes-since 否 String 镜像最后更新时间

功能介绍 该接口用于上传用户本地的镜像文件到云平台。使用该接口上传镜像时，镜像文件大小需要小于2GB，超过2GB的镜像文件参考注册镜像进行操作。 了解更多关于使用外部文件创建镜像的相关内容，请参见“通过外部镜像文件创建Windows系统盘镜像”、“通过外部镜像文件创建Linux系统盘镜像”。 使用该接口上传镜像的具体步骤如下： 准备待上传的镜像，支持的镜像格式：QCOW2、VMDK、VHD、RAW、VHDX、QED、VDI、QCOW、ZVHD2和ZVHD。 使用创建镜像元数据（OpenStack原生）创建镜像元数据。调用成功后，保存该镜像的ID。 使用2得到的镜像ID，上传支持格式的镜像文件。

URI PUT /v2/images/{image_id}/file 参数说明请参见表1。 表1 参数说明 参数 是否必选 参数类型 描述 image_id 是 String 镜像ID。 image_id为用户调用创建镜像元数据接口所创建出来镜像的id，使用其他方式创建的镜像id会导致上传失败。 上传接口调用成功后，请根据镜像id查询镜像的状态。镜像状态变为active表示镜像上传成功。 AK/SK签名认证方式仅支持消息体大小在12MB以内，12MB以上的请求请使用Token认证。