华为云用户手册

  • 元模型详述 ABM进行元模型建模后的画布视图,其描述了所有的实体联接,并支撑如下核心功能: 数据普查目录:使用“用户、行政单元、行政领域、应用、数据平台实例、数据容器、数据集、数据集字段”实体。 数据资产目录:使用“用户、主题域分组、主题域、业务对象、逻辑数据实体、属性、数据标准、数据平台实例、数据容器、数据集、数据集字段”实体。 分析师360:使用“团队、用户、空间、报表、报表分组、数据集”实体。 图4 枢纽元模型V2.0
  • 元模型概述 FabricMetamodelV2.0内核和扩展实体如图3所示。 图3 FabricMetamodelV2.0概览 FabricMetamodelV2.0内核中包括如下的一些实体: 行政单元(AdministrationUnit):行政单元指按照各行业固有的行政管理结构来划分、具备行政管理职责的单位。如政府的省/市/区、企业的集团/分支机构、法人实体等。 行政领域(AdministrationDomain):在企业组织范围内,行政领域指基于向外部和内部客户提供的商品或服务的主要子结构,如零售、物流、云计算服务等;在政府领域内,行政领域指政府各职能领域,如工商、公安、卫检等。 用户(User):数据资产管理和运营用户旅程中的个人参与方,如数据管家、数据分析师、数据普查员等。 空间(Space):用于描述数据分析师的工作空间,此空间为一个逻辑概念,空间中涵盖了“数据分析师团队、团队拥有的数据底座、有访问权限的数据资产、数据开发工具、数据应用”等关联概念。 主题域分组(SubjectAreaGroup):公司顶层信息分类,通过数据视角体现公司最高层关注的业务领域。 主题域(SubjectArea):互不重叠数据的高层面的分类,用于管理下一级的业务对象。 业务对象(BusinessObject):业务领域重要的人、事、物,承载了业务运作和管理涉及的重要信息。 逻辑数据实体(LogicalEntity):具有一定逻辑关系的数据属性的集合。 属性(Attribute):描述业务对象的数据特征,是数据最基本的单元。 数据标准(DataStandard):定义组织层面需共同遵守的属性层数据含义和业务规则,是组织层面对某个数据的共同理解,这些理解一旦确定下来,就应作为组织层面的标准在组织内被共同遵守。 应用(Application):应用是数据资产运营枢纽中对IT系统的统称,包括文件应用、业务系统应用、企业应用、 数据仓库 应用等。 数据平台实例(DataPlatformInstance):数据源是元数据的来源。包括以下几类来源:关系型数据库(比如MySQL、Oracle)、对象存储(比如华为云OBS)、企业应用(比如金碟ERP)、BI软件(比如四方伟业BI、帆软BI)、大数据存储(比如Hive、HDFS)、消息队列(比如kafka)、ETL工具(比如AWS Glue)、 时序数据库 (比如influx)等。数据源又称数据平台实例。 数据集(DataSet):代表了数据的集合,通常指数据库中的表/视图、流处理系统中的流、 数据湖 系统中以文件或文件夹形式存在的数据集合等。 数据集容器(Container):包括一组DataSet的逻辑库。 数据集字段(SchemaField):数据集中的每一列字段对应一个数据集字段。 FabricMetamodelV2.0扩展中包括如下的一些实体: 团队(Group):数据资产管理和运营用户旅程中的团队参与方。 报表(Report):以特定格式展现数据的一种可视化报告,能直观地展现业务分析结果,用于支撑业务决策。 报表分组(ReportGroup):对报表的分类信息。 卡片(Card):报表由多个可视化组件组成,一个可视化组件称为卡片。 主要的实体联接的描述如下: 兼容FabricMetamodelV1.0的信息架构管理的实体联接: 信息架构L1-L5层元素间的实体联接: “属性-被包含-逻辑数据实体”:描述信息架构中L5层属性和L4层逻辑实体的关系。 “逻辑数据实体-被包含-业务对象”:描述信息架构中L4层逻辑数据实体和L3层业务对象的关系。 “业务对象-被包含-主题域”:描述信息架构中L3层业务对象和L2层主题域的关系。 “主题域-被包含-主题域分组”:描述信息架构中L2层主题域和L1层主题域分组的关系。 信息架构和用户之间的实体联接: “主题域分组-关联于-团队”:描述的是信息架构委员会团队管理所有主题域分组、领域数据管家团队管理本领域主题域的场景。 “主题域分组-被拥有-用户”:描述的是数据Owner管理主题域分组的场景。 “主题域-被拥有-用户”:描述的是数据Owner作为主题域数据主人的场景。 “业务对象/逻辑数据实体-被管理-用户”:描述的是数据管家管理业务对象/逻辑数据实体的场景。 “业务对象/逻辑数据实体-被拥有-用户”:描述的是数据Owner管理业务对象/逻辑实体的场景。 信息架构和数据集之间的实体联接: “数据集-关联于-逻辑数据实体”:描述的是多个物理存在的数据集,关联到一个逻辑数据实体进行管理的场景。比如一张物理表在源业务系统、业务系统备库、数据湖、数据仓库中存在了多次,则其被注册到一个逻辑数据实体中。逻辑数据实体中的属性是从管理维度定义的最重要的数据资产属性,和数据集字段可能存在不完全一致的情况。 “数据集-关联于-业务对象”:此关系是在未定义“逻辑数据实体”时引入的,当前已经失效,将在FabricMetamodelV2.1中删除。 兼容FabricMetamodelV1.0的数据普查的实体联接: 数据普查L1-L5层元素间的实体联接: “数据集-被包含-数据容器”:描述数据库的逻辑库(如Schema)包含多个数据集的场景。 “数据集-被包含-数据平台实例”:描述数据集存储在哪个数据平台实例的场景。 “数据平台实例-关联于-应用”:描述业务系统关联数据平台实例的场景。 “应用-关联于-行政领域”:描述此业务系统是哪一个业务领域建设的场景。 “行政领域-被包含-行政单元”:描述是业务领域是哪一级组织(如集团、分公司)的场景。 兼容FabricMetamodelV1.0的RDBMS的实体联接: “数据集字段-被包含-数据集”:描述的是数据集(物理表/视图)包括哪些字段的场景。 “数据集-被包含-数据集容器”:描述的是逻辑库中包括哪些数据集(物理表/视图)的场景。 “数据集-被包含-数据平台实例”:描述的是数据集(物理表/视图)实际存储在哪个数据平台实例的场景。 RDBMS元模型中CWM元模型中如下元素尚未兼容: 唯一键 主键 外键 存储过程 索引/索引字段 触发器 分析师360中管理数据消费的实体联接: “空间-被拥有-用户”:描述的是空间Owner拥有工作空间的场景,当前空间中成员信息没有保存在元模型中。 “数据集-被消费-报表”:描述的是物理表被BI报表应用所消费的场景。 “报表-被拥有-用户”:描述的是报表是由哪个数据分析师创建、开发和发布的场景。 “报表-被包含-报表分组”:描述的是BI报表进行分组管理的场景。 “报表分组-被包含-工作空间”:描述的是工作空间中由数据分析师开发了多个BI报表的场景。 数据管家360中管理数据普查的实体联接: “数据集-被拥有-用户”:描述的是数据Owner作为数据集数据主人的场景。 “数据集-被管理-用户”:描述的是数据管家作为数据集管理者的场景。
  • 元模型设计原则 企业架构元模型的核心目的是“Organize、Analyze、Communicate”: Organize:组织是指将企业中流程、业务能力、应用、技术、人等组成企业架构的元素形成一张完整的视图。在元模型设计方法中,是利用适当的抽象方法,来将类似概念抽象,这样在看企业架构的时候,能够看到最关键的组成要素,而不是陷入细节。 Analyze:分析是指能够使用企业架构元数据去回答关键的业务问题。在元模型设计方法中,需要将元素合理的进行组织,以方便查询关键的元数据,来回答这些业务问题。 Communicate:沟通是指能够让受众清晰易懂理解企业架构的关键元素。比如如果一个元模型中定义了dashboard,受众要能够理解其含义是仪表盘。元模型是企业架构师向受众讲述架构故事的一种媒介,如果一些有价值的见解被模糊的概念或者晦涩的技术所掩盖,那么受众将很难获得有价值的决策信息。 元模型设计的七个原则,以帮助企业架构师设计比较好的元模型 限制元模型中组件(Component,即本文语境中的实体)和引用类型(Reference Type)的数量: 对实体和引用类型的数量要保守,控制企业架构元模型的复杂度至关重要。假设你使用15个实体定义一个领域元模型来描述Cloud Service,此时是清晰明了的;如果你需要进一步描述Cloud Service如何支撑应用、应用如何支撑业务流程、业务流程如何形成商业产品和服务,此时就需要跨领域元模型,如果每个领域都是15个实体,此时60个实体之间要建立关系和查询能力,会变得异常复杂;未来降低这种复杂度,就需要进行一定程度的抽象。 避免过度具体化或过度抽象化。 简化和整合标准以满足需求: 在参考多个建模标准之前,请了解多个建模标准中的重叠部分,每个标准都是面向一个特定领域的,例如BPMN用于业务流程建模,UML用于软件工程建模,ITIL用于IT运维建模,ERD用于数据建模等。 在必要时消除多个标准中的重复部分和简化标准。 定义多个业务、IT团队共同的语言: 理解不同的部门、团队可能对相同的概念使用不同的术语,例如Dynamics CRM、Application、Deployment Package表达的是一个意思。 使用例子来描述概念的异同处。 使用层次机构来组织架构中的架构元素: 在架构中为架构元素构建层级结构,使得架构时可以从不同层次来描述此元素,如图1和图2所示。 根据时间的推移及时刷新层级结构。 图1 应用分类(An Application taxonomy) 图2 位置分类(A Location taxonomy) 确保高阶概念(High-Level)和低阶概念(Low-Level)的匹配: 理解哪些实体是高阶概念、哪些是低阶设计,如业务能力(Business Capability)或者价值流(Value Stream)被认为是高阶概念,功能(Function)或者业务流程(Business Process)被认为是低阶概念。 检查高阶概念的实体和关系,在低阶概念中对应的一致性。构建企业架构模型需要的是一个持续的过程,在高阶概念和低阶概念模型之间相互检查,寻找差距(gaps)和脱节(disconnects),持续的协调一致。 体系结构模型的顶层(高阶概念)的目的是聚合细节(低阶概念),而不是消除细节;建议先从低阶概念设计开始,根据业务和IT的工作逐步抽象高阶概念。 在使用抽象实体类型需注意: 使用抽象实体类型对其他实体类型进行分类。 如果使用不当,抽象实体类型可能会降低您进行影响分析或建立可追溯性的能力。 举例:部门A使用Outlook,其可以定义为“Organization A- Uses - Outlook”;部门B使用Gmail,其可以定义为“Organization - Uses - Gmail”;如果将Outlook和Gmail抽象为TechnologyService实体,其值为Email,则部门A和B使用的都是Email服务,无法直接得出使用的邮件服务的差异。 最完美的元模型是持续演进的: 建立一个有合理信心的内核模型(Core),但不要害怕扩展实验。 根据用户反馈、技术演进和这七个原则来不停演进企业架构元模型。
  • 修改告警通知主题 修改告警通知的关联项目ID、通知主题、通知状态(0为关闭通知,1为开启通知)等通用配置。 输入参数 输入参数说明如表40所示。 表40 修改告警通知主题输入参数说明 参数 必填 说明 告警通知状态 否 告警通知状态。 消息通知 主题的唯一资源标识符 否 消息通知主题的唯一资源标识符。 告警主题id 否 告警主题ID。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表41。 表41 修改告警通知主题输出参数说明 参数 说明 msg 返回消息。 status 返回状态。
  • 创建扫描规则 输入参数 输入参数说明如表34所示。 表34 创建扫描规则输入参数说明 参数 必填 说明 规则类别 否 规则类别。 规则ID 否 规则ID。 逻辑运算符 否 逻辑运算符。 最小匹配次数 否 最小匹配次数。 风险等级 否 风险等级。 规则内容 否 规则内容。 规则描述 否 规则描述。 规则名称 否 规则名称。 规则类型 否 规则类型。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表35。 表35 创建扫描规则输出参数说明 参数 说明 msg 返回消息。 status 返回状态。
  • 创建扫描任务 输入参数 输入参数说明如表36所示。 表36 创建扫描任务输入参数说明 参数 必填 说明 资产ID列表 否 资产ID列表。 扫描周期 否 扫描周期。 扫描任务名 否 扫描任务名 是否开启任务 否 是否开启任务。 规则组ID列表 否 规则组ID列表 扫描任务开始时间 否 扫描任务开始时间。 时区 否 时区。 主题的唯一资源标识符 否 主题的唯一资源标识符。 是否用nlp 否 是否用nlp。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表37。 表37 创建扫描任务输出参数说明 参数 说明 msg 返回消息。 status 返回状态。
  • 修改扫描规则 输入参数 输入参数说明如表38所示。 表38 修改扫描规则输入参数说明 参数 必填 说明 规则类别 否 规则类别。 规则ID 否 规则ID。 逻辑运算符 否 逻辑运算符。 最小匹配次数 否 最小匹配次数。 风险等级 否 风险等级。 规则内容 否 规则内容。 规则描述 否 规则描述。 规则名称 否 规则名称。 规则类型 否 规则类型。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表39。 表39 修改扫描规则输出参数说明 参数 说明 msg 返回消息。 status 返回状态。
  • 提取数据水印 输入参数 输入参数说明如表21所示。 表21 提取数据水印输入参数说明 参数 必填 说明 水印密钥 否 水印密钥。 字段类型列表 否 字段类型列表。 -数据的字段名称 否 数据的字段名称。 -数据的字段类型 否 数据的字段类型。 -标记该字段是否为主键 否 标记该字段是否为主键。 水印数据 否 水印数据。 -col 否 col。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表22。 表22 提取数据水印输出参数说明 参数 说明 watermarks 提取水印内容列表。
  • 嵌入数据水印 输入参数 输入参数说明如表25所示。 表25 嵌入数据水印输入参数说明 参数 必填 说明 添加水印的内容 否 添加水印的内容。 水印密钥 否 水印密钥。 数据的字段名称 否 数据的字段名称。 数据的字段类型 否 数据的字段类型。 标记该字段是否为主键 否 标记该字段是否为主键。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表26。 表26 嵌入数据水印输出参数说明 参数 说明 嵌入水印后的数据 嵌入水印后的数据。 -item2 嵌入水印后的数据2。 -item1 嵌入水印后的数据1。
  • 创建扫描规则组 输入参数 输入参数说明如表32所示。 表32 创建扫描规则组输入参数说明 参数 必填 说明 规则类别 否 规则类别。 规则组描述 否 规则组描述。 规则组名称 否 规则组名称。 包含的规则ID列表 否 包含的规则ID列表。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表33。 表33 创建扫描规则组输出参数说明 参数 说明 msg 返回消息。 status 返回状态。
  • 对数据进行脱敏 输入参数 输入参数说明如表27所示。 表27 对数据进行脱敏输入参数说明 参数 必填 说明 脱敏策略列表 否 脱敏策略列表。 需要脱敏的字段名称 否 需要脱敏的字段名称。 脱敏算法名称 否 脱敏算法名称。 脱敏算法参数 否 脱敏算法参数。 数据列表 否 数据列表。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表28。 表28 对数据进行脱敏输出参数说明 参数 说明 masked_data 脱敏后的数据列表。
  • 查看资产列表 输入参数 该执行动作无需输入参数。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表18。 表18 查看资产列表输出参数说明 参数 说明 buckets OBS桶列表。 -asset_name 资产名称。 -bucket_location 桶位置。 -bucket_name 桶名称。 -bucket_policy 桶策略。 -create_time 创建时间。 -deleted 是否被删除。 -id 桶ID。 -is_deleted 是否被删除。 total OBS桶总数。
  • 查询OpenApi调用记录 输入参数 输入参数说明如表16所示。 表16 查询OpenApi调用记录输入参数说明 参数 必填 说明 分页大小 否 分页大小。 需要查询调用记录的URL 否 需要查询调用记录的URL。 开始时间 否 OpenApi调用的开始时间。 结束时间 否 OpenApi调用的结束时间。 指定标识符 否 指定标识符。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表17。 表17 查询OpenApi调用记录输出参数说明 参数 说明 total total succeed succeed failed failed openapi_called_records openapi_called_records -user_name user_name -user_id user_id -domain_name domain_name -domain_id domain_id -request_url request_url -request_method request_method -response_code response_code -fail_reason fail_reason -timestamp -timestamp next_marker next_marker
  • 查看规则列表 输入参数 输入参数说明如表19所示。 表19 查看规则列表输入参数说明 参数 必填 说明 页码 否 页码。 分页大小 否 分页大小。 project_id 是 项目ID。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表20。 表20 查看规则列表输出参数说明 参数 说明 total 规则总数。 rules 规则列表。 -category 规则分类。 -delete_allowed 是否允许删除。 -group_names 分组名称。 -id 规则ID。 -logic_operator logic_operator -min_match min_match -risk_level 风险等级。 -rule_content 规则内容。 -rule_desc 规则描述。 -rule_name 规则名称。 -rule_type 规则类型。 -selected selected
  • 查询告警通知主题 输入参数 输入参数说明如表14所示。 表14 查询告警通知主题输入参数说明 参数 必填 说明 页码 否 页码。 分页大小 否 分页大小。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表15。 表15 查询告警通知主题输出参数说明 参数 说明 default_topic_urn 默认消息通知主题的唯一资源标识符。 topic_count 已确认的消息通知主题数量。 topics 已确认的消息通知主题列表。 -name 消息通知主题名称。 -topic_urn 消息通知主题的唯一资源标识符。
  • 查询扫描规则组列表 输入参数 输入参数说明如表10所示。 表10 查询扫描规则组列表输入参数说明 参数 必填 说明 页码 否 页码。 分页大小 否 分页大小。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表11。 表11 查询扫描规则组列表输出参数说明 参数 说明 total total groups groups -id -ID -group_name group_name -group_desc group_desc -category category -rule_names rule_names -task_names task_names -delete_allowed delete_allowed -is_default is_default
  • 查询扫描任务列表 输入参数 输入参数说明如表12所示。 表12 查询扫描任务列表输入参数说明 参数 必填 说明 页码 否 页码。 分页大小 否 分页大小。 内容 否 内容。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表13。 表13 查询扫描任务列表输出参数说明 参数 说明 total 任务总数。 tasks 本次返回的扫描任务列表。 -id 任务ID。 -name 任务名称。 -cycle 任务执行方式。 -status 任务当前状态。 -open 任务开启状态。 -rule_groups 任务使用的规则组。 -last_run_time 任务上一次执行时间。 -create_time 任务创建时间。 -last_scan_risk 任务上一次扫描风险等级结果。 -use_nlp 是否使用了NLP进行扫描。 -topic_urn SMN 服务通知主题。 -start_time 任务扫描开始时间。
  • 查询指定任务扫描结果 输入参数 输入参数说明如表8所示。 表8 查询指定任务扫描结果输入参数说明 参数 必填 说明 页码 否 页码。 分页大小 否 分页大小。 资产类型 否 资产类型。 任务ID 是 指定任务的ID。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表9。 表9 查询指定任务扫描结果输出参数说明 参数 说明 job_id job_id job_name job_name type type db_scan_result db_scan_result -total total -db_scan_results db_scan_results --task_id task_id --db_name db_name --table_id table_id --table_name table_name --risk_level risk_level --sensitive_data_type sensitive_data_type --match_info match_info ---column_name column_name ---rule_name rule_name ---rule_id rule_id ---rule_risk_level rule_risk_level ---column_line column_line
  • 查询脱敏任务执行列表 输入参数 输入参数说明如表6所示。 表6 查询脱敏任务执行列表输入参数说明 参数 必填 说明 工作区ID 否 工作区ID。 页码 否 页码。 分页大小 否 分页大小。 模板ID 是 模板ID。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表7。 表7 查询脱敏任务执行列表输出参数说明 参数 说明 tasks 任务。 -db_type db_type -end_time 查询脱敏任务截止时间。 -execute_line execute_line -id ID -progress progress -run_status 查询脱敏任务的运行状态。 -start_time 查询脱敏任务的开始时间。 -task_template_id task_template_id -type type total total
  • 添加资产授权 添加数据资产扫描授权。 输入参数 输入参数说明如表4所示。 表4 添加资产授权输入参数说明 参数 必填 说明 资产类型 否 资产的类型。 OBS桶列表 否 支持输入框和数组两种模式。 输入框:请选择数组类型的节点输出。 数组:资产名称、桶位置、桶名称、桶策略等。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表5。 表5 添加资产授权输出参数说明 参数 说明 返回消息 返回消息。 返回状态 返回状态。
  • 管理 域名 对域名进行管理,实现任意域名生效就会运行流的目的。域名管理的操作请参考表3。 需要绑定到API分组的域名需要满足以下条件: 已有独立域名。 需要绑定的域名已经cname解析到该分组的子域名b4dff2cc395e474eb0c837624c75eac6.apig.cn-north-7.huaweicloudapis.com,否则无法绑定。 需要绑定的域名已经完成ICP备案,否则无法绑定。 如果API分组中的API支持H TTS 请求协议,则需要为独立域名添加SSL证书。 表3 管理域名的操作 操作项 操作及说明 绑定独立域名 单击“绑定独立域名”,输入域名,单击“确定”。创建成功的域名展示在列表中,最多支持创建5个独立域名。 域名的格式为:abc.com 解除绑定独立域名 在独立域名列表中,在对应的“操作”列下,单击“解除绑定”,单击“确定”。 添加SSL证书 当API分组中的API支持HTTS请求协议时,才有此操作。 在独立域名列表中,在对应的“操作”列下,单击“添加SSL证书”,输入已获取的证书名称、证书内容及密钥。单击“确定”。 证书内容及密钥使用的是pem编码,可以单击“样例”,查看样例。 查看证书 当API分组中的API支持HTTS请求协议时,才有此操作。 在独立域名列表中,在对应的“操作”列下,单击“查看证书”,可以查看证书详细信息。 编辑SSL证书 当API分组中的API支持HTTS请求协议时,才有此操作。 在独立域名列表中,在对应的SSL证书列下,单击,可以修改证书名称、证书内容及密码。 删除证书 当API分组中的API支持HTTS请求协议时,才有此操作。 在独立域名列表中,在对应的“操作”列下,单击“删除证书”,可以删除已添加的证书。
  • 响应 “响应”执行动作需和API流的触发动作一起配合使用,用户通过此执行动作可以根据需要定制接口的响应信息。 其中响应体为Json格式的字符串,响应头为键值对(key=value)形式返回。 输入参数 用户配置响应执行动作,相关参数说明如表2所示。 表2 响应输入参数说明 参数 必须 说明 状态码 是 选择状态码,有200、201、400、401、500、502。支持输入框和下拉框两种模式。 响应体 否 设置响应体名称。 响应头的key 否 设置响应头的键,为数组模式。 响应头的值 否 设置响应头的数值,为数组模式。 响应头 否 设置响应头,需要选择数组类型的节点输出,为输入框模式。 输出参数 该执行动作无输出参数说明。
  • Token认证 Token的有效期为24小时,需要使用同一个Token鉴权时,可以缓存起来,避免频繁调用。 获取Token 后,再调用其他接口时,需要在请求消息头中添加“X-Auth-Token”,其值即为Token。例如Token值为“ABCDEFJ....”,则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可,如下所示。 GET https://mssi.cn-north-4.myhuaweicloud.com/v1/{project_id}/flows/running-history Content-Type: application/json X-Auth-Token: ABCDEFJ.... 还可以通过这个视频教程了解如何使用Token认证:https://bbs.huaweicloud.com/videos/101333 。 还可以参考华为云 IAM 认证服务了解如何获取IAM用户Token。
  • AK/SK认证 AK/SK签名认证方式仅支持消息体大小12M以内,12M以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名,在请求时将签名信息添加到消息头,从而通过身份认证。 AK(Access Key ID):访问密钥ID。与私有访问密钥关联的唯一标识符;访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。 SK(Secret Access Key):与访问密钥ID结合使用的密钥,对请求进行加密签名,可标识发送方,并防止请求被修改。 使用AK/SK认证时,可以基于签名算法使用AK/SK对请求进行签名,也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。
  • 请求示例 PUT https://{endpoint}/v3/{project_id}/abm/instances/{instance_id}/metadata3/entities/{entity_urn} { "package_id": "Metamodel3", "entity_name": "主题域02", "entity_type": "Metamodel3-SubjectArea", "entity_attributes": [ { "attribute_id": "Metamodel3-SubjectArea-NAME", "attribute_value": "" }, { "attribute_id": "Metamodel3-SubjectArea-PermissionCode", "attribute_value": "" }, { "attribute_id": "Metamodel3-SubjectArea-OrderNumber", "attribute_value": "" }, { "attribute_id": "entity_name", "attribute_value": "主题域02" } ], "signatures": [ { "signature_name": "测试", "signature_type": "Metamodel3-descriptionInfo", "signature_attributes": [ { "attribute_id": "Metamodel3-descriptionInfo-NAME", "attribute_value": "测试" }, { "attribute_id": "Metamodel3-descriptionInfo-description", "attribute_value": "" }, { "attribute_id": "Metamodel3-descriptionInfo-nameEn", "attribute_value": "" }, { "attribute_id": "Metamodel3-descriptionInfo-nameCn", "attribute_value": "" }, { "attribute_id": "Metamodel3-descriptionInfo-dataAssetNumber", "attribute_value": "" } ] }, { "signature_name": "", "signature_type": "Metamodel3-maintenanceInfo", "signature_attributes": [ { "attribute_id": "Metamodel3-maintenanceInfo-NAME", "attribute_value": "" }, { "attribute_id": "Metamodel3-maintenanceInfo-createdBy", "attribute_value": "" }, { "attribute_id": "Metamodel3-maintenanceInfo-createTime", "attribute_value": "" }, { "attribute_id": "Metamodel3-maintenanceInfo-updatedBy", "attribute_value": "" }, { "attribute_id": "Metamodel3-maintenanceInfo-updateTime", "attribute_value": "" }, { "attribute_id": "Metamodel3-maintenanceInfo-creatorAccount", "attribute_value": "" }, { "attribute_id": "Metamodel3-maintenanceInfo-updaterAccount", "attribute_value": "" } ] } ] }
  • 响应示例 状态码: 200 successful operation { "entity_type": "Metamodel3-SubjectArea", "entity_attributes": [ { "attribute_id": "Metamodel3-SubjectArea-NAME", "attribute_name_en": "NAME", "attribute_name": "名称", "attribute_value": "", "attribute_code": "NAME" }, { "attribute_id": "Metamodel3-SubjectArea-PermissionCode", "attribute_name_en": "PermissionCode", "attribute_name": "权限编码", "attribute_value": "", "attribute_code": "PermissionCode" }, { "attribute_id": "Metamodel3-SubjectArea-OrderNumber", "attribute_name_en": "OrderNumber", "attribute_name": "顺序值", "attribute_value": "", "attribute_code": "OrderNumber" }, { "attribute_id": "entity_name", "attribute_name_en": null, "attribute_name": null, "attribute_value": "主题域02", "attribute_code": null } ], "entity_urn": "urn:abm:Metamodel3-SubjectArea:e0ee33d38c01167db2c63695f20929", "entity_name": "主题域02", "package_id": "Metamodel3", "signatures": [ { "signature_attributes": [ { "attribute_id": "Metamodel3-descriptionInfo-NAME", "attribute_name_en": "NAME", "attribute_name": "名称", "attribute_value": "测试", "attribute_code": "NAME" }, { "attribute_id": "Metamodel3-descriptionInfo-description", "attribute_name_en": "Description", "attribute_name": "描述内容", "attribute_value": "", "attribute_code": "description" }, { "attribute_id": "Metamodel3-descriptionInfo-nameEn", "attribute_name_en": "NameEn", "attribute_name": "英文名", "attribute_value": "", "attribute_code": "nameEn" }, { "attribute_id": "Metamodel3-descriptionInfo-nameCn", "attribute_name_en": "NameCn", "attribute_name": "中文名", "attribute_value": "", "attribute_code": "nameCn" }, { "attribute_id": "Metamodel3-descriptionInfo-dataAssetNumber", "attribute_name_en": "DataAssetNumber", "attribute_name": "资产编码", "attribute_value": "", "attribute_code": "dataAssetNumber" } ], "signature_name": "测试", "version": "0", "signature_type": "Metamodel3-descriptionInfo" }, { "signature_attributes": [ { "attribute_id": "Metamodel3-maintenanceInfo-NAME", "attribute_name_en": "NAME", "attribute_name": "名称", "attribute_value": "", "attribute_code": "NAME" }, { "attribute_id": "Metamodel3-maintenanceInfo-createdBy", "attribute_name_en": "CreatedBy", "attribute_name": "创建人", "attribute_value": "", "attribute_code": "createdBy" }, { "attribute_id": "Metamodel3-maintenanceInfo-createTime", "attribute_name_en": "CreateTime", "attribute_name": "创建时间", "attribute_value": "", "attribute_code": "createTime" }, { "attribute_id": "Metamodel3-maintenanceInfo-updatedBy", "attribute_name_en": "UpdatedBy", "attribute_name": "修改人", "attribute_value": "", "attribute_code": "updatedBy" }, { "attribute_id": "Metamodel3-maintenanceInfo-updateTime", "attribute_name_en": "UpdateTime", "attribute_name": "修改时间", "attribute_value": "", "attribute_code": "updateTime" }, { "attribute_id": "Metamodel3-maintenanceInfo-creatorAccount", "attribute_name_en": "CreatorAccount", "attribute_name": "创建账号", "attribute_value": "", "attribute_code": "creatorAccount" }, { "attribute_id": "Metamodel3-maintenanceInfo-updaterAccount", "attribute_name_en": "UpdaterAccount", "attribute_name": "修改账号", "attribute_value": "", "attribute_code": "updaterAccount" } ], "signature_name": "", "version": "0", "signature_type": "Metamodel3-maintenanceInfo" } ] }
  • 请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 package_id 否 String 模型包ID。 entity_name 否 String 实体名称。 entity_type 否 String 实体类型。 entity_attributes 否 Array of 表4 objects 实体属性。 signatures 否 Array of 表3 objects 特征。 表3 MetadataSignature 参数 是否必选 参数类型 描述 signature_type 否 String 特征类型。 signature_name 否 String 特征名称。 signature_attributes 否 Array of 表4 objects 特征属性。 表4 MetadataAttributeRequest 参数 是否必选 参数类型 描述 attribute_id 否 String 属性ID。 attribute_value 否 String 属性值。
  • URI PUT /v3/{project_id}/abm/instances/{instance_id}/metadata3/entities/{entity_urn} 表1 路径参数 参数 是否必选 参数类型 描述 entity_urn 是 String 实例urn。 project_id 是 String 项目ID,获取方法请参考获取项目ID。 instance_id 是 String 实例的ID。 最小长度:1 最大长度:64
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 package_id String 模型包ID。 entity_urn String 实体urn。 entity_name String 实体名称。 entity_type String 实体类别。 entity_attributes Array of 表7 objects 实体属性。 signatures Array of 表6 objects 特征。 表6 MetadataEntitySignatureResp 参数 参数类型 描述 signature_name String 特征名称。 signature_type String 特征类型。 signature_attributes Array of 表7 objects 特征属性。 表7 MetadataAttributeResp 参数 参数类型 描述 attribute_id String 属性ID。 attribute_value String 属性值。 attribute_code String 属性编码。 attribute_name String 属性名称。 attribute_name_en String 属性英文名称。 状态码: 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。
  • 支持的授权项 策略包含系统策略和自定义策略,如果系统策略不满足授权要求,管理员可以创建自定义策略,并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应,授权项列表说明如下: 权限:允许或拒绝在特定条件下对制定资源进行某项操作。 对应API接口:自定义策略实际调用的API接口。 授权项:自定义策略中支持的Action,在自定义策略中的Action中写入授权项,可以实现授权项对应的权限功能。 依赖的授权项:部分Action存在对其他Action的依赖,需要将依赖的Action同时写入授权项,才能实现对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project):自定义策略的授权范围,包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目,表示此授权项对应的自定义策略,可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目,不支持企业项目,表示仅能在IAM中给用户组授权并生效,如果在企业管理中授权,则该自定义策略不生效。管理员可以在授权项列表中查看授权项是否支持IAM项目或企业项目,“√”表示支持,“×”表示暂不支持。关于IAM项目与企业项目的区别,详情请参见:IAM与企业管理的区别。 开天 集成工作台 的支持自定义策略授权项如下所示: 流管理,包括流接口对应的授权项,如提交运行流、启用流程、禁用流程、webhook触发流程调用等接口。
共100000条