华为云用户手册

创建生命线 生命线介绍 通用生命线（Lifeline），边界生命线（Boundary Lifeline），实体生命线（Entity Lifeline），控制生命线（Control Lifeline），参与者生命线（Actor Lifeline）。生命线的类型不会影响消息线的连线逻辑。 创建生命线 在创建生命线前，需要先考虑哪种类型的生命线能更好地表示你所要表达的对象。您可以通过以下三种方式创建生命线。 工具画板中选择一个生命线拖拽至画布中。 从工程树中其它模型视图中的元素拖拽至画布中生成对应生命线，您可以使用Link方式引用。 生命线也支持由创建消息线（Create Message）触发创建，其位置通常低于别的生命线。 生命线移动、延长 若画布中存在两条及以上生命线，单个生命线不支持上下垂直移动，只支持左右水平移动。 全选生命线后，可以在垂直方向上移动，调整元素在画布中的位置。 调整任一生命线的高度，其余生命线会同步调整，保证所有生命线底部对齐。 如果生命线是通过Create Message创建的，则可以操作该Create Message对目标生命线进行上下移动，但时间上不能早于之前最早生命线。 生命线变更 右键单击生命线，选择“元素设置/替换”可以修改生命线类型及替换成模型工程中其它元素。 元素设置：修改元素的类型及构造型。 元素替换：替换成其它元素。 父主题： 顺序图

用例图 用例图用于编写测试用例，将角色与用例联系起来。 表1 用例图元素介绍 元素名 图标 含义 Use Case 用例，代表的是一个完整的功能。 Test Case 测试用例，是原型的用例元素。通过将元素属性和功能应用于由另一个元素或更确切地说是元素集表示的功能的测试，您可以使用它来扩展“测试”窗口的功能。 Actor 角色，是与系统交互的人或事物。 Boundary 边界，可以放入元素，形成一个模块。 Collaboration 是对对象和链总体安排的一个描述，这些对象和链在上下文中通过互操作完成一个行为，例如一个用例或者操作。 Collaboration Use 使用协作用于在复合结构图中将协作定义的模式应用于特定情况。 Package 包。对元素进行分组，并为分组的元素提供名称空间。一个程序包可能包含其他程序包，从而提供程序包的分层组织。 Generalization 组合，是整体与部分的关系，但部分不能离开整体而单独存在。 Realization 实现，是一种类与接口的关系，表示类是接口所有特征和行为的实现。 Association 关联，是一种拥有的关系，它使一个类知道另一个类的属性和方法。 Dependency 依赖，是一种使用的关系，即一个类的实现需要另一个类的协助。 Constraint 是一个语义条件或者限制的表达式。UML 预定义了某些约束，其他可以由建模者自行定义。 Anchor 锚点。 Containment 内嵌，表示嵌在内部的类。 Include 基用例与包含用例之间的关系。说明如何将包含用例中定义的行为插入基用例定义的行为中。基用例可以看到包含用例，并依赖于包含用例的执行结果。但是二者不能访问对方的属性。 Extend 是指扩展用例与基用例之间的关系。特别是如何将扩展用例定义的行为插入基用例定义的行为序列。 Use 使用，是一种使用的关系。表明一个模块在运行的时候，需要使用另外一个模块。 用例图示例，如下图所示： 父主题： UML建模

交互概述图 交互概述图元素介绍如下表所示： 表1 交互概述图元素介绍 元素名 图标 含义 Action 动作是可执行的原子计算，它导致模型状态的改变和返回值。 Activity 活动是状态机内正在进行的非原子执行。 StructuredActivity 结构化活动是一个活动节点，可以将下级节点作为独立的活动组。 CentralBufferNode 中央缓冲区节点是一个对象节点，用于管理活动图中表示的来自多个源和目标的流。 Datastore 数据存储区定义了永久存储的数据。 Object 封装了状态和行为的具有良好定义界面和身份的离散实体；即对象实例。 Decision 是状态机中的一个元素，在它当中一个独立的触发可能导致多个可能结果，每个结果有它自己的监护条件。 Merge 状态机中的一个位置，两个或多个可选的控制路径在此汇合或"无分支"。 Send 发送者对象生成一个信号实例并把它传送到接收者对象以传送信息。 Receive 接收就是处理从发送者传送过来的消息实例。 Partition 分区元素用于逻辑组织元素。 Partition 分区元素用于逻辑组织元素。 Initial 用来指明其默认起始位置的伪状态。 Final 组成状态中的一个特殊状态，当它处于活动时，说明组成状态已经执行完成。 Flow Final Flow Final元素描述了系统的退出，与Activity Final相反，后者代表Activity的完成。 Synch 一个特殊的状态，它可以实现在一个状态机里的两个并发区域之间的控制同步。 Fork Join (Fork)复杂转换中，一个源状态可以转入多个目标状态，使活动状态的数目增加。 (Join)状态机活动图或顺序图中的一个位置，在此处有两个或以上并列线程或状态归结为一个线程或状态。 Fork Join (Fork)复杂转换中，一个源状态可以转入多个目标状态，使活动状态的数目增加。 (Join)状态机活动图或顺序图中的一个位置，在此处有两个或以上并列线程或状态归结为一个线程或状态。 Region 并发区域。 Exception Handler 异常处理。捕获异常根据异常类型查找到对应的异常处理方法，然后执行对应的方法。 Control Flow （控制流）在交互中，控制的后继轨迹之间的关系。 Object Flow （对象流）各种控制流表示了对象间的关系、对象和产生它（作输出）或使用它（作输入）的操作或转换间的关系。 Interrupt Flow 中断流是用于定义异常处理程序和可中断活动区域的连接器的两个UML概念的连接。 交互概述图示例，如下图所示： 此图描绘了一个示例销售过程，在示例中显示了一个交互销售过程，各活动对象都可以有独立的子交互概述图。 父主题： UML建模

组合结构图 组合结构图元素介绍如下表所示： 表1 组合结构图元素介绍 元素名 图标 含义 Class 是对象的集合，展示了对象的结构以及与系统的交互行为。 Interface 接口，可以是单个接口，也可以是抽象的一组接口的组合。 圆形接口与矩形接口意义相同，仅形状不同。 Property 特性就是表示传递有关模型元素信息的值的一般性术语。属性具有语义效果，在 UML中一部分属性已经事先定义好了，其他的特性是用户定义的。 Port 端口定义了分类器与其环境之间的交互。 Collaboration 协作定义了一组协作角色及其连接器。 CollaborationUse 使用协作用于在复合结构图中将协作定义的模式应用于特定情况。 Provided Interface Required Interface Required Interface和Provided Interface之间可以建立Dependency，表明一个组件需要的接口是由另外一个组件提供的。 Connector 连接器通常在“组合结构”图中说明零件之间的通信链接以实现结构的目的。 Delegate 委托连接器在组件图上定义了组件外部端口和接口的内部组件。 Role Binding 角色绑定是协作使用的内部角色和实现特定情况所需的各个部分之间的映射，通常在复合结构图中。 Ocurrence 在组合结构图中，发生关系表示协作表示分类器。 Represents 表示连接器指示在分类器（通常在“组合结构”图中）中使用了协作。 组合结构图示例，如下图所示： 此图显示了协作在组合结构图中显示执行安装的关系的图 父主题： UML建模

通信图 通信图元素介绍如下表所示： 表1 通信图元素介绍 元素名 图标 含义 Actor 角色，是与系统交互的人或事物。 Object 封装了状态和行为的具有良好定义界面和身份的离散实体；即对象实例。 Boundary Object 边界对象。 Control Object 控制对象。 Entity Object 实体对象。 Package 包。对元素进行分组，并为分组的元素提供名称空间。一个程序包可能包含其他程序包，从而提供程序包的分层组织。 Nesting 嵌套，即一个类的嵌套到另一个类。 Realization 实现，是一种类与接口的关系，表示类是接口所有特征和行为的实现。 Association 关联，是一种拥有的关系，它使一个类知道另一个类的属性和方法。 通信图示例，如下图所示： 父主题： UML建模

4+1视图规范一致性检查错误修复指导 XX模型不能存在游离的逻辑模型元素 以逻辑模型为例: 游离原因：元素没有在逻辑模型架构信息树中出现。 查看逻辑模型架构方案设置。 找到游离元素构造型相关的架构配置信息。 Subsystem需要与System有Composition/Aggregation关系或父子关系。 在模型图中构建架构关系。 XX模型的元素要与指定的XX模型层次结构保持一致 以逻辑模型为例: 查询逻辑模型架构信息树，右侧操作开关把展示不匹配架构方案的元素打开。 架构信息树构出后 根据错误元素名称查询定位到其所在架构树节点。 查询错误元素与其他元素关系。 对比架构方案设置。 Subsystem1报错是因为与System1（架构信息树上的父节点）存在错误架构关系，对比发现实际模型图中使用的是Dependency连线 而架构配置方案要求Composition/Aggregation。 在模型图中修改连线类型为Composition/Aggregation。 常见错误场景： 连线类型不符合架构配置方案。 规则 实际 子元素构造型不符合架构配置方案。 System下层子元素按架构配置方案只能是Subsystem、Domain、Service、MS 图中是Component。 父主题： 架构检查

2.8.1运行模型、运行模型-顺序图、运行模型-活动图中不能产生新的逻辑元素 详细描述 在运行模型中不能创建新的逻辑元素，只能从逻辑模型中引用或者实例化到运行模型中来进行设计。 检查范围 当前模型工程中的所有模型图类型为运行模型图上的逻辑元素，逻辑元素的定义参考逻辑模型检查章节。 如何检查 查询所有运行模型图中的元素，找出在运行模型图中创建生成出来的逻辑元素。 正确示例 引用自逻辑模型的中定义的逻辑元素。 错误示例 检测结果：

2.3.5逻辑元素至少与一个代码元素存在manifest关系 详细描述 逻辑模型中的逻辑元素或从逻辑模型引用到代码模型中的逻辑元素至少要与一个代码元素中间有manifest连线关系。 当前规则支持配置检查类型后，已包含3.1.1的检查项，建议使用2.3.6检查项即可，3.1.1可不再重复检查。 检查范围 在逻辑模型图上创建出来的逻辑模型元素； 引用到代码模型中的逻辑元素； 排除Interface、Provided Interface、Required Interface元素。 如何检查 检查规则配置中勾选要检查的元素类型，服务、微服务、组件、模块是默认强制勾选的检查类型，检查这类元素在代码模型图中是否与代码元素存在manifest连线关系，由代码元素指向逻辑元素，不存在对应的代码元素则不符合规则 ，将该类逻辑元素列出到检查结果中。 正确示例 错误示例 引用过来的逻辑元素Interface没有对应任何代码元素。

建模步骤 创建上下文模型。 您可以使用初始化创建的上下文模型或者创建新的上下文模型，在目录节点右键“新增图”，如果一个系统的交互的外部角色过多时，不适合在一张上下文模型图中建模时，用户可根据外部角色的分类或者产品的应用场景创建不同的上下文模型。 建立系统与外部角色的关系。 在上下文模型中描述系统与外部角色的关系通过接口体现，不直接使用连线表示；在上下文模型中需要定义外部角色、交互接口、外部系统、系统，其中系统如果在逻辑模型中已经定义过，则在上下文模型中不能再重复定义，从逻辑模型中引用至上下文模型中即可。

概述 运行视图面向系统运行，描述系统启动过程、运行期交互的视图，主要解决系统运行期交互，描述各可执行交付件在运行期的交互关系。 表1 运行视图 模型类别 描述 运行模型（可选） 运行模型描述系统运行期间的关系，从进程的维度描述系统运行时的交互过程和关键数据流。 运行模型-顺序图（必选） 运行模型-顺序图模型是从逻辑模型中的架构对象维度描述系统运行时的交互过程以及关键的数据流。 运行模型-活动图（可选） 运行模型-活动图展示了从起点到终点的工作流程，详细说明了在活动的进展中存在的许多决策路径。 父主题： 运行视图

概述 部署视图面向系统部署，描述系统的交付、安装、部署的视图，主要解决系统安装部署的问题，描述系统的交付、安装、部署关系。 表1 部署视图 模型类别 描述 交付模型(必选) 交付模型定义的是从构建结果和外部软件一起打包成最终交付给客户的Release Offering的模型设计过程。 部署模型(必选) 部署模型定义产品的部署关系，它依托于构建模型或交付模型，描述每个构建文件或者交付件以及相应的软件部署实体的部署依赖关系和部署约束。 父主题： 部署视图

建模步骤 创建构建模型。 创建新的构建模型图或者在已有的构建模型图中进行画图设计，如果设计内容过多，可根据实际情况将内容进行拆分，创建多个构建模型图，在对应的构建模型图中去建立关系。 引用代码元素到构建模型。 将代码元素引用到构建模型中跟代码模型中的步骤2一样，有两种方式，从工程树上将代码元素拖入到构建模型图中选link方式引用 ；另一种从代码模型图中多选复制元素，以引用方式粘贴到构建模型图中。 建立代码元素与构建元素的Build From构建关系。 在步骤2中将代码元素引用到构建模型图后，再从工具箱中构建模型图形库中拖入构建元素，创建与代码元素需要建立关系的构建元素，并建立构建元素与代码元素的Build From关系，同时需要创建一些构建过程中构建元素使用到的构建工具和依赖的构建环境、平台等信息，并建其中的连线关系。

建模步骤 创建代码模型图。 创建新的代码模型图或者在已有的代码模型图中进行画图设计，如果设计内容过多，可根据实际情况将内容进行拆分，创建多个代码模型图，在对应的代码模型图中去建立关系。 引用逻辑元素到代码模型。 在代码模型中不能创建新的逻辑元素，必须要从逻辑模型中引用到代码模型中，引用逻辑元素的操作方式有两种 方式一：直接从工程树上将逻辑元素节点拖入到打开的代码模型图中，选择Link方式。 方式二：在逻辑模型图中按Ctrl键多选或者框选多个逻辑元素Ctrl+C复制，然后再到代码模型中Ctrl+V粘贴，粘贴方式选择引用方式，可以保留嵌套组合的结构样式。 上述两种方式都可以将逻辑元素引用到代码模型图中，在代码模型中只需要引用需要建立映射关系的逻辑元素即可。 创建代码元素并与逻辑元素建立Manifest连线关系。 在步骤2中将逻辑元素引用到代码模型中后，再从工具箱中拖入代码仓元素，如果存在一个代码仓组下的多个代码仓元素，可以选代码仓组元素，将多个代码仓元素包含起来，如果具体模块对应的是代码仓中某一目录中的代码，则需要在对应的代码仓元素中创建Dir目录元素，再建立对应逻辑元素与代码元素的Manifest关系。

概述 开发视图面向系统开发及软件管理，描述系统代码结构，构建结构的视图，主要解决系统技术实现和开发的问题，它依托逻辑视图，描述代码、构建结构。 模型类别 描述 代码模型(必选) 代码模型定义代码结构以及代码元素逻辑模型中逻辑元素的对应关系，建立逻辑元素到代码仓或者代码目录的映射关系，以实现软件源代码的显示管理。 构建模型(必选) 构建模型定义软件编译构建结构及工具链，构建模型建立代码到运行期文件的映射和追溯关系。 父主题： 开发视图

概述 逻辑视图面向系统逻辑分析和设计，描述系统逻辑结构的视图，主要解决系统分析和设计的问题，它描述系统的业务上下文、系统的逻辑分解，以及分解出的逻辑元素间的关系。 模型类别 描述 逻辑模型（必选） 逻辑模型描述系统的逻辑功能模块分解，将系统分解为相应的逻辑功能元素，并描述各逻辑功能元素之间的关系。 数据模型（强数据场景必选） 数据模型定义系统的关键数据设计，包括关键数据结构设计、数据流，以及数据所有权等。 领域模型（可选） 领域模型描述业务域的概念及其关系，是立足于于业务域的分析模型，它通过业务问题域的分析和建模，抽象出领域概念，建立统一的业务语言，从而指导后续的架构设计工作。 功能模型（可选） 功能模型描述按功能分解出特性、功能组、功能元素，以及它们之间的依赖关系。 技术模型（必选） 技术模型定义系统采用的关键技术部件和技术栈，包括整体框架技术，公共机制，基础设施，公共服务/组件，以及各逻辑功能元素的技术方案等。 父主题： 逻辑视图

概述 4+1视图是一组相关联模型的集合，从不同的视角，反映不同利益干系人的关注点。通过逻辑、开发、部署、运行4个典型视角描述系统的各个切面，以用例串接和验证各切面设计。 在架构设计说明书模板中的4+1架构视图模型结构如下图所示： 图1 4+1架构视图模型结构图 表1 视图类型与描述 视图类型 描述 逻辑视图 逻辑视图面向系统逻辑分析和设计，是描述系统逻辑结构的视图，主要解决系统分析和设计的问题，它描述系统的业务上下文、系统的逻辑分解，以及分解出的逻辑元素间的关系。 开发视图 开发视图面向系统开发及软件管理，是描述系统代码结构，构建结构的视图，主要解决系统技术实现和开发的问题，它依托逻辑视图，描述代码、构建结构。 运行视图 运行视图面向系统运行，是描述系统启动过程、运行期交互的视图，主要解决系统运行期交互，描述各可执行交付件在运行期的交互关系。 部署视图 部署视图面向系统部署，是描述系统的交付、安装、部署的视图，主要解决系统安装部署的问题，描述系统的交付、安装、部署关系。 用例视图 用例视图以用例作为驱动元素，驱动和验证其他四个视图的设计，用例视图不增加设计元素，仅增加用例作为输入，因此作为“+1”视图。 父主题： 4+1视图建模

权限管理 CodeArts Modeling中默认的用户角色类型及对建模的操作权限说明如下： “默认角色权限矩阵” 资源权限 项目经理 测试经理 运维经理 开发人员 测试人员 参与者 浏览者 查看（可打开模型图，只读） √ √ √ √ √ √ √ 创建（可在任何包下新增包、图、元素） √ √ √ √ √ × × 更新（可修改任何包、图、元素） √ √ √ √ √ × × 删除（可删除任何包、图、元素） √ √ √ √ √ × × 配置（可操作工程设置） √ × × × × × × 执行（可执行架构检查） √ √ √ √ √ √ × 复制（可复制图） √ √ √ √ √ × × 自创建（在自己包下面创建包、图、元素，在其他人创建的包下可建图、元素） √ √ √ √ √ √ × 自更新（只能修改自己创建的包、图、元素） √ √ √ √ √ √ × 自删除（只能删除自己建的包、图、元素） √ √ √ √ √ √ × “√”表示默认有权限，“ ×”表示默认没有权限。

数据保护技术 架构建模通过多种数据保护手段和特性，保证通过架构建模的数据安全可靠，如下表所示： 表1 数据保护手段 数据保护手段 简要说明 详细介绍 传输加密（HTTPS） 访问全链路采用HTTPS数据传输方式，保证数据传输安全。 - 个人数据保护 架构建模通过控制个人数据访问权限以及通过 云审计 服务记录操作日志等方法，防止个人数据泄露，保证您的个人数据安全。 权限控制 隐私数据保护 涉及到用户的数据库账号信息需要存储时，提供敏感 数据加密 存储，支持加密密钥轮换更新。 - 数据备份 支持用户数据备份。 - 父主题： 安全

身份认证与访问控制 身份认证 用户访问CodeArts Modeling的方式有多种，包括CodeArts Modeling用户界面、API，无论访问方式封装成何种形式，其本质都是通过CodeArts Modeling提供的REST风格的API接口进行请求。 CodeArts Modeling的接口需要经过认证请求后才可以访问成功。CodeArts Modeling支持两种认证方式： Token认证：通过Token认证调用请求，常用的鉴权方式。请参见Token鉴权。 AK/SK认证：通过AK（Access Key ID）/SK（Secret Access Key）加密调用请求。推荐使用AK/SK认证，其安全性比Token认证要高。请参见AK/SK鉴权。 访问控制 CodeArts Modeling支持通过权限控制（ IAM 权限）进行访问控制，如下表所示： 访问控制方式 简要说明 详细介绍 权限控制 IAM权限 IAM权限是作用于云资源的，IAM权限定义了允许和拒绝的访问操作，以此实现云资源权限访问控制。默认情况下，管理员创建的IAM用户没有任何权限，需要将其加入用户组，并给用户组授予策略或角色，才能使得用户组中的用户获得对应的权限。 IAM产品介绍 父主题： 安全

责任共担 华为云秉承“将公司对网络和业务安全性保障的责任置于公司的商业利益之上”。针对层出不穷的 云安全 挑战和无孔不入的云安全威胁与攻击，华为云在遵从法律法规业界标准的基础上，以安全生态圈为护城河，依托华为独有的软硬件优势，构建面向不同区域和行业的完善云服务安全保障体系。 安全性是华为云与您的共同责任，如图1所示。 华为云：负责云服务自身的安全，提供安全的云。华为云的安全责任在于保障其所提供的 IaaS、PaaS 和 SaaS 类云服务自身的安全，涵盖华为云数据中心的物理环境设施和运行其上的基础服务、平台服务、应用服务等。这不仅包括华为云基础设施和各项云服务技术的安全功能和性能本身，也包括运维运营安全，以及更广义的安全合规遵从。 租户：负责云服务内部的安全，安全地使用云。 华为云租户的安全责任在于对使用的 IaaS、PaaS 和 SaaS 类云服务内部的安全以及对租户定制配置进行安全有效的管理，包括但不限于虚拟网络、 虚拟主机 和访客虚拟机的操作系统，虚拟防火墙、API 网关和高级安全服务，各项云服务，租户数据，以及身份账号和密钥管理等方面的安全配置。 《华为云安全白皮书》详细介绍华为云安全性的构建思路与措施，包括云安全战略、责任共担模型、合规与隐私、安全组织与人员、基础设施安全、租户服务与租户安全、工程安全、运维运营安全、生态安全。 图1 华为云安全责任共担模型 父主题： 安全

计费说明 架构建模不支持单独购买，开通/购买CodeArts后即可使用CodeArts Modeling服务。 CodeArts基础版/专业版介绍请参考计费说明。 在CodeArts支持的区域内，各区域独立开通购买、独立计费。 新用户定义：在华为云当前区域未开通过CodeArts按需服务组合、单个服务的按需，未购买过CodeArts包月套餐包（1元/1000元），未创建过任何CodeArts项目和资源。

产品优势 实时协同设计 支持多人实时编辑和协作，多浏览器实时同步渲染，用户在建模过程中可以实时看到模型的变化，减少冲突和覆盖，提高建模设计工作的效率。 4+1视图建模 内置华为多年架构设计变更实践成果，支持业界通用UML和4+1视图建模。 模型跨团队共享复用 支持跨工程、跨团队对模型库进行共享和复用，适用于多个子产品、上下游系统间的协同，模型图、模型对象参考同源、引用同源、变更同源，形成全关联的全量系统架构。 架构规范检查 内置了公司实践的架构设计 40+ 检查规则集，自动识别设计中的缺陷或者违反的设计规范，并提供相应的报告和可视化反馈。

请求示例 创建一个名为“IAMAgencyPolicy”的委托自定义策略。策略表示作用范围为全局服务，委托资源的URI是/iam/agencies/07805acaba800fdd4fbdc00b8f888c7c。 POST https://iam.myhuaweicloud.com/v3.0/OS-ROLE/roles { "role": { "display_name": "IAMAgencyPolicy", "type": "AX", "description": "IAMDescription", "description_cn": "中文描述", "policy": { "Version": "1.1", "Statement": [ { "Effect": "Allow", "Action": [ "iam:agencies:assume" ], "Resource": { "uri": [ "/iam/agencies/07805acaba800fdd4fbdc00b8f888c7c" ] } } ] } } }

响应示例 状态码为 201 时: 创建成功。 { "role": { "catalog": "CUSTOMED", "display_name": "IAMAgencyPolicy", "description": "IAMDescription", "links": { "self": "https://iam.myhuaweicloud.com/v3/roles/f67224e84dc849ab954ce29fb4f47f8e" }, "policy": { "Version": "1.1", "Statement": [ { "Action": [ "iam:agencies:assume" ], "Resource": { "uri": [ "/iam/agencies/07805acaba800fdd4fbdc00b8f888c7c" ] }, "Effect": "Allow" } ] }, "description_cn": "中文描述", "domain_id": "d78cbac186b744899480f25bd02...", "type": "AX", "id": "f67224e84dc849ab954ce29fb4f47f8e", "name": "custom_d78cbac186b744899480f25bd022f468_0" } }

响应参数 表7 响应Body参数 参数 参数类型 描述 role Object 自定义策略信息。 表8 role 参数 参数类型 描述 catalog String 自定义策略所在目录。 display_name String 自定义策略展示名。 description String 自定义策略的描述信息。 links Object 自定义策略的资源链接信息。 policy Object 自定义策略的具体内容。 description_cn String 自定义策略的中文描述信息，仅在请求中传入了description_cn参数，响应体中才会返回此字段。 domain_id String 自定义策略所属账号ID。 type String 自定义策略的显示模式。 说明： AX：全局服务。 XA：区域级项目。 自定义策略的显示模式只能为AX或者XA，不能同时在全局服务和区域级项目生效（AA），或者在全局服务和区域级项目都不生效（XX）。 id String 自定义策略ID。 name String 自定义策略名。 updated_time String 自定义策略更新时间。 说明： UNIX时间戳格式，单位是毫秒，时间戳格式如：1687913793000。 created_time String 自定义策略创建时间。 说明： UNIX时间戳格式，单位是毫秒，时间戳格式如：1687913793000。 表9 role.links 参数 参数类型 描述 self String 资源链接地址。 表10 role.policy 参数 参数类型 描述 Version String 权限版本号。 说明： 1.0：系统预置的角色。以服务为粒度，提供有限的服务相关角色用于授权。 1.1：策略。IAM最新提供的一种细粒度授权的能力，可以精确到具体服务的操作、资源以及请求条件等。 Statement Array of objects 授权语句，描述自定义策略的具体内容。 表11 role.policy.Statement 参数 参数类型 描述 Action Array of strings 授权项，指对资源的具体操作权限。支持的授权项请参考各云服务《API参考》中“权限和授权项”章节。 说明： 当自定义策略为委托自定义策略时，该字段值为： "Action": ["iam:agencies:assume"]。 Effect String 作用。包含两种：允许（Allow）和拒绝（Deny），既有Allow又有Deny的授权语句时，遵循Deny优先的原则。 取值范围： Allow Deny Resource Object 委托资源，仅在创建请求中传递此字段，才会返回此对象。在有其他账号与您创建了多个委托关系，即您是被委托方，需要将委托中的权限授权给不同的用户组，这些用户组中的IAM用户进行角色切换时，仅能切换到被授权的委托中，不能切换其他委托。例： "Resource": {"uri": ["/iam/agencies/07805acaba800fdd4fbdc00b8f888c7c"]} 表12 role.policy.Statement.Resource 参数 参数类型 描述 uri Array of strings 委托资源的URI，长度不超过128。格式为：/iam/agencies/委托ID。例： "uri": ["/iam/agencies/07805acaba800fdd4fbdc00b8f888c7c"]

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json;charset=utf8”。 X-Auth-Token 是 String 访问令牌，承载用户的身份、权限等信息。 token所需权限请参见授权项。 表2 请求Body参数 参数 是否必选 参数类型 描述 role 是 Object 自定义策略信息。 表3 role 参数 是否必选 参数类型 描述 display_name 是 String 自定义策略展示名，长度1~128字符之间。 type 是 String 自定义策略的显示模式。 说明： AX：全局服务。 XA：区域级项目。 自定义策略的显示模式只能为AX或者XA，不能同时在全局服务和区域级项目生效（AA），或者在全局服务和区域级项目都不生效（XX）。 description 是 String 自定义策略的描述信息。 description_cn 否 String 自定义策略的中文描述信息。 policy 是 Object 自定义策略的具体内容。 表4 role.policy 参数 是否必选 参数类型 描述 Version 是 String 权限版本号，创建自定义策略时，该字段值填为“1.1”。 说明： 1.0：系统预置的角色。以服务为粒度，提供有限的服务相关角色用于授权。 1.1：策略。IAM最新提供的一种细粒度授权的能力，可以精确到具体服务的操作、资源以及请求条件等。 Statement 是 Array of objects 授权语句，描述自定义策略的具体内容。 表5 role.policy.Statement 参数 是否必选 参数类型 描述 Action 是 Array of strings 授权项，指对资源的具体操作权限。支持的授权项请参考各云服务《API参考》中“权限和授权项”章节。 说明： 当自定义策略为委托自定义策略时，该字段值为： "Action": ["iam:agencies:assume"]。 取值范围： iam:agencies:assume Effect 是 String 作用。包含两种：允许（Allow）和拒绝（Deny），既有Allow又有Deny的授权语句时，遵循Deny优先的原则。 取值范围： Allow Deny Resource 否 Object 委托资源。在有其他账号与您创建了多个委托关系，即您是被委托方，需要将委托中的权限授权给不同的用户组，这些用户组中的IAM用户进行角色切换时，仅能切换到被授权的委托中，不能切换其他委托。例： "Resource": {"uri": ["/iam/agencies/07805acaba800fdd4fbdc00b8f888c7c"]} 表6 role.policy.Statement.Resource 参数 是否必选 参数类型 描述 uri 是 Array of strings 委托资源的URI，长度不超过128。格式为：/iam/agencies/委托ID。例： "uri": ["/iam/agencies/07805acaba800fdd4fbdc00b8f888c7c"]

响应示例 状态码为 200 时: 请求成功。 { "login_protects" : [ { "user_id" : "75226081f43d4c628c4bb88cf32e9...", "enabled" : true, "verification_method" : "email" }, { "user_id" : "16b26081f43d4c628c4bb88cf32e9...", "enabled" : true, "verification_method" : "vmfa" }, { "user_id" : "56b26081f43d4c628c4bb88cf32e9...", "enabled" : true, "verification_method" : "sms" } ] }

响应参数 表2 响应Body参数 参数 参数类型 描述 login_protects Array of objects 登录状态保护信息列表。 说明： 只返回开启过登录保护的用户状态信息。 表3 login_protects 参数 参数类型 描述 enabled Boolean IAM用户是否开启登录保护，开启为"true"，未开启为"false"。 user_id String IAM用户ID。 verification_method String IAM用户登录验证方式。

响应参数 表7 响应Body参数 参数 参数类型 描述 console_acl_policy object Console访问控制策略。 表8 console_acl_policy 参数 参数类型 描述 allow_address_netmasks Array of objects 允许访问的IP地址或网段，仅在设置了允许访问的IP地址或网段才会返回此字段。 allow_ip_ranges Array of objects 允许访问的IP地址区间，仅在设置了允许访问的IP地址区间才会返回此字段。 表9 allow_address_netmasks 参数 参数类型 描述 address_netmask String IP地址或网段，例如:192.168.0.1/24。 description String 描述信息。 表10 allow_ip_ranges 参数 参数类型 描述 description String 描述信息。 ip_range String IP地址区间，例如:0.0.0.0-255.255.255.255。

请求示例 修改账号的控制台访问策略：允许访问的IP地址区间为“0.0.0.0-255.255.255.255”。 PUT https://iam.myhuaweicloud.com/v3.0/OS-SECURITYPOLICY/domains/{domain_id}/console-acl-policy { "console_acl_policy": { "allow_ip_ranges": [ { "ip_range": "0.0.0.0-255.255.255.255" } ] } }