华为云用户手册

人工智能性能优化 1.训练优化模型性能提升实践 参数调优策略：调整模型flash attention、并行切分策略、micro batch size、重计算策略等参数。 尽可能充分利用显存和算力，通过参数调优，初步优化性能。 性能拆解 参数调优后性能仍然与转商目标有较大的差距，需要考虑进行profiling，采集性能数据后从更底层的算子、通信、调度和内存等维度将性能进行拆解分析，训练脚本中加入profiling代码。具体步骤：生成profiling数据目录结构；利用att工具，将NPU与竞品之间的数据进行端到端耗时对比分析；Tracing分析。 算子分析 通过生成profiling中的summary文件对具体的算子进行分析，考虑算子层面向FA与MM算子方向优化。 2.路由规划加速最佳实践 ranktable路由规划是一种用于分布式并行训练中的通信优化能力，在使用NPU的场景下，支持对节点之间的通信路径根据交换机实际topo做网络路由亲和规划，进而提升节点之间的通信速度。本案例介绍如何在ModelArts Lite场景下使用ranktable路由规划完成Pytorch NPU分布式训练任务，训练任务默认使用Volcano job形式下发到Lite资源池集群。详细步骤可参考最佳实践文档。 训练显存优化实践 pytorch的内存池基本管理策略 pytorch的内存池以block为粒度来进行管理，block池分为小内存池与大内存池，block是pytorch向device驱动申请内存的粒度，整存整取。用户/Pytorch代码向内存池申请内存的接口归一为tensor的申请释放（这点最开始也不是很好理解，也就是说：任何一个pytorch代码申请内存的地方，均表现为一个tensor的申请释放）。 tensor的生命周期使用类似智能指针的引用计数方式来管理，且打通了Python与C++的通道，即：一个Python的tensor对象关联一个C++的tensor对象，Python的tensor对象的消失会触发C++的tensor对象析构释放内存。一个在C++环境里创建的tensor对象可以返回成一个Python的tensor对象。 C++的tensor对象分为两部分：一部分是viewTensor，包含tensor的各种meta信息：shape, stride, dataType等，一部分是storageTensor，包含具体的内存addr，offset，对外呈现的是viewTensor，这是pytorch做view类操作后，多个tensor对应同一块内存的基本支撑。在storageTensor申请时，向pytorch的block池申请一块内存，找到空闲块之后，视实际要求对block进行切分使用并返回address指针。 pytorch的内存的跨流复用策略 如果一个stream上的内存池里申请的tensor需要给另一个stream使用，那么则需要进行recordStream操作，将这个tensor的所属block标识上新stream的信息，在这个tensor的生命周期消失触发address释放时，发现其所属block有其他stream信息，此时会给对应stream下发一个event_record task然后返回。 在之后本stream在每一次新申请内存时，均做一下event_query操作，如果发现event已经被record则其他stream上的task已经执行完成，此时可以放心地回收这个block。 Pytorch的内存统计信息说明 pytorch的内存一般看三个峰值信息：allocated / active / reserved。allocated对应host上的tensor实际申请了但是没释放的内存（注意：是在host上申请释放，不代表device状态）。active对应host上还未释放的内存+还在被别的流占用的内存。 举例，一个tensor在streamA上申请了，让供streamB做allreduce的集合通信操作，然后tensor进过一次add后被释放，此时：释放会减去allocated值，但是不会减去active 值，直至这个allreduce真实执行之后，通过query_event查询到结果之后触发释放，才会减去active值。 reserved对应pytorch向device申请了的内存，比如申请了100M，然后释放了，然后又申请了20M，还未释放，此时的allocated 为20M，reserved为100M。真实网络里，reserved里存在大量block被切小了的可使用内存但是当申请一个大块内存时又无法复用，这种会导致reserved 与 allocated 的较大差值，通常称为内存碎片。 pytorch的内存碎片影响因素 一个step里更多的内存申请释放内存次数理论上一定会导致更多的内存碎片，为什么说是一个step呢？因为pytorch内存池只取决于host上的训练脚本逻辑，而每个step的训练脚本逻辑是相同的，所以一般第一个step之后内存状态可以稳定下来。 不同生命周期的tensor交替地申请释放，因为pytorch向驱动申请是整存整取，所以：一个常规的优秀做法是把长生命周期放在最开始申请，这样不易形成碎片。而workspace内存由于可以绝对意义上地串行复用，因此对此单独做一个定制的内存池策略可以减少对内存碎片影响，在NPU上常见的非连续转连续操作，就是一个相对GPU来说较多的内存申请。 显存优化策略 由于大模型的参数成倍数的增长，远超出了单GPU物理显存所能承载的范围，大模型训练必然需要进行显存优化。显存优化要么是优化算法本身，降低模型算法的显存消耗；要么是去扩大显存，通过一些置换方式获得“额外“空间，由于显存物理大小一定，我们获得额外空间的方式不外乎两种：时间换空间和空间转移。其中，时间换空间通常会消耗算力、带宽；空间转移主要是消耗I/O带宽，有一定的时延，可能会降低吞吐。 观测性能指标 指标ID 指标名称 指标说明 cpu_usage CPU使用率 该指标用于统计ModelArts用户服务的CPU使用率。 mem_usage 内存使用率 该指标用于统计ModelArts用户服务的内存使用率。 gpu_util GPU使用率 该指标用于统计ModelArts用户服务的GPU使用情况。 gpu_mem_usage GPU显存使用率 该指标用于统计ModelArts用户服务的GPU显存使用情况。 npu_util NPU使用率 该指标用于统计ModelArts用户服务的NPU使用情况。 npu_mem_usage NPU显存使用率 该指标用于统计ModelArts用户服务的NPU显存使用情况。 disk_read_rate 磁盘读取速率 统计ModelArts用户服务的磁盘读取速率。 disk_write_rate 磁盘写入速率 统计ModelArts用户服务的磁盘写入速率。 全量指标可参考ModelArts支持的监控指标文档。 父主题： 云服务性能优化介绍

产品规格差异 Astro工作流提供了基础版、专业版和企业版三种不同的规格套餐，以满足不同场景下的用户需求。关于各规格的详细介绍，请参见表1。 基础版：满足个人及创业团队的基础需求，用户能够低门槛入门使用该产品。 专业版：满足中大企业搭建复杂业务场景的需求，提供了更多定制和集成的功能。 企业版：满足大企业搭建高性能复杂场景的需求，支持高级流程和表单的设计。 表1 Astro工作流套餐规格清单 版本类型 基础版 专业版 企业版 组织用户数 10人以内 50人起 50人起 创建、发布应用数 5个 100个 300个 应用模板 50个 1000个 6000个 单应用表单数 30个 100个 500个 单应用流程数 50个 100个 500个 单表单数据上限 1万条 20万条 50万条 单流程版本数 100个 200个 300个 流程模板 / / 500个 总数据调用次数 2万次/年 说明： 每月上限为2000次。如何计算数据调用次数，请参见在AstroFlow中，如何计算总数据调用次数。 20万次/年 50万次/年 自定义连接器 5个 100个 300个 存储空间 20G 125G 250G 包含专属工作台 支持 支持 支持 业务门户风格定制 支持 支持 支持 第三方服务集成 支持使用官方连接器和5个自定义连接器 支持使用官方连接器和100个自定义连接器 支持使用官方连接器和300个自定义连接器 高级流程编排能力 不支持 不支持 支持 高级表单设计能力 不支持 不支持 支持 不同版本的Astro工作流套餐包含不同的功能，详细功能说明请参见表2。 表2 Astro工作流套餐功能说明 功能名称 功能描述 组织用户数 组织内的用户人数。 应用数 创建、发布的应用数量。 总数据调用次数 购买版本的总数据调用次数。 单表单数据上限 单表数据量和总数据量中的“数据量”指的是通过表单提交的数据记录，提交一次即生成一条数据，也可以理解为数据的行数。 存储空间 可用的附件及相关资料的存储空间总量。 专属工作台 组织专属工作台功能。 （可选）第三方服务集成 自定义连接器，用于集成第三方服务在Astro工作流中使用。 （可选）流程、表单高级功能 在基础表单、流程功能基础上，对组件功能及设置进行了增强。 （可选）业务门户风格定制 可定制组织的业务门户风格和展示应用信息等。

连接器 连接器是AstroFlow提供的调用第三方服务的集成工具。通过连接器，开发者无需关注具体代码实现，只需要选择所需的连接器和配置动作，即可在流程中快速集成其他系统。在AstroFlow中您可以使用Astro低代码平台中提供的官方连接器和自定义连接器。 官方连接器：Astro低代码平台封装了不同类型的连接器对接相应的服务，帮助您拼装能力、联接云端、打通行业，让您的应用无所不能。Astro低代码平台中提供的官方连接器，可在AstroFlow中的流程中直接使用。 自定义连接器：当官方连接器不能满足需求时，可通过自定义连接器，将第三方服务集成到AstroFlow流程中使用。自定义连接器包括从Astro低代码平台中转存的官方连接器和在AstroFlow中自定义的连接器。 图2 连接器

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

Astro Flow InstanceManagement策略内容 { "Version": "1.1", "Statement": [ { "Action": [ "astroflow:instances:*" ], "Effect": "Allow" } ] }

财务管理 企业的实际场景中，不同的企业所需的管理流程不同，但面对的企业财务控制难点是殊途同归的，如事前无计划、费用控制难执行、审核耗精力和结果难统计等。这些问题可以通过表单、流程和应用的个性化构建快速支撑实际的使用，合同管理、借款付款、报销发票等实现一站式管理和数据查看，从而提高财务管理效率，降低财务风险。 AstroFlow提供了一套可自行管理和定制的自动化流程引擎服务，以财务人员的办公流程为场景基础，满足企业中财物、合同、款项的管理、流动、统计的数字化需求，还可以利用已有的财务管理模板搭建出个性化、适应企业自身使用需求的财务管理系统、收付款管理系统和发票报销管理系统等。 信息化工作流程 可以选择标准化的收付款、报销、发票应用模板并根据实际需求在模板的基础上进行个性自定义（编辑、修改），做到功能随需而动，还可以根据实际场景配置对应的表单和流程，明细信息可追溯、可修正。 工作流及时管理 多终端的费用保险、合同审批、发票管理功能，实现系统定时自动提醒，为财务人员分角色生成工作台，审批流程及时推送创建对应待办流程，不再遗忘收付款，缩短财务流程处理周期。 数据报表可视化 财务模块可自定义大屏分析表盘，生成财务流水、可视化呈现、企业财务情况实时掌握，减轻了财务人员负担，大幅提高财务人员工作效率，为企业提供经营决策的支持数据。

行政管理 AstroFlow适用于中小企业的行政管理，针对企业资料管理混乱、审批流程繁琐等问题，对行政工作进行科学化、信息化管理，包括物资领用、出入凭证、车辆调配、访客登记等摆脱纸质流程。 物资领用管理 领用管理及发放记录，方便员工申请。 会议室管理 提前预约会议室，充分利用会议室资源。 公告通知 通知到位，同时方便员工查询告知。 访客管理 线上预约、线下核验，访客预约、到访、记录和存档。 车辆管理 为企业统筹车辆的安排，管理车辆状态、驾驶员状态，查看报表数据，从而合理配置资源。

人事管理 人力资源业务没有标准的准则规范，且不同行业、不同规模、不同发展阶段的企业 人力资源管理 重点并不一致，很难形成统一的业务标准并找到完全适配的标准化HR系统产品。传统的人力资源管理系统的功能设计，无法快速适配到实际的现代化企业的人事管理实际场景中，并且开发流程耗时长、维护成本高、迭代敏捷度低，无法助力企业的高效运营。 使用AstroFlow可快速构建业务流程及自动化工作流程，从本质上释放HR的双手，提高工作效能，提升员工的使用体验，联合数据洞察，助力企业智慧决策，满足企业集团化、个性化管理需求。 针对企业传统的人事管理模式，AstroFlow提供了可定制化的流程管理服务，可落地应用到多样化的人事管理场景中，如企业的人员入职、离职、请假、差旅等流程审批等。 轻松入职，人员信息不遗漏 HR快速定制入职信息表单，定制信息栏目新人指南等模块功能，便于人员信息管理和查找。 流程规范电子化、协助新同事业务快速上手。 全方位自定义信息字段，由企业按需配置使用。 入转调离，无忧动态管理 组织结构灵活调整，灵活流程配置、审批节点快速设置，关键节点动态跟踪，信息安全留存。 提升协同效率，规范流程表单，可覆盖员工入、转、调、离、复全场景的人员管理。 无代码配置和调整各类人事流程，无论是审批、待办、信息收集，皆可流程化设置、自动化推送审批消息。 休假、差旅管理轻松数字化 灵活配置的工作流程，可以支撑不同行业标准和工时、排班和休假模式。 提供多场景的管理应用模板，可快速复用，覆盖企业的差旅、休假、人员管理等实际场景。

Astro工作流产品功能 统一底座平台能力，为企业客户数字化转型打好坚实基础 组织管理：提供统一组织角色权限控制管理RBAC模型，权限可控，管理统一。 产品学习：打造低代码领域学习资源池，阶梯化的专家成长路径，协助用户快速上手。 资产中心：提供平台级多业务资产，供多业务场景用户开箱即用，构建快、选择多、标准化。 一站式业务门户构建，千商千面，灵活搭建企业应用中心 统一应用收口：企业可灵活搭建业务门户，为企业提供统一的、系统化应用组合收口。 自由应用组合：支持Astro低代码平台中企业搭建的应用、大屏等多场景应用组合解决方案。 个性化门户：支持客户定制个性化门户页面、实现千商千面。 流程编排全面升级，定制更高效，编排更灵活 多种触发类型：流程支持多种触发类型，可根据业务需求按需控制工作流的触发条件。 流程模板：支持流程模板灵活引用，无缝升级和回滚，实现流程高度重用。 海量官方连接器：丰富的云服务与行业连接器，快速创建、轻松配置，灵活组装。 表单构建能力升级，打造无纸化办公新体验 丰富的组件库：可视化拖拉拽&丰富表单组件库，快速可视化组件和页面搭建。 灵活打通数据：业务数据轻松打通，一键创建数据管理出口。 表单、流程独立发布：支持表单、流程独立发布，快速应对各类业务场景的客户诉求。

代码接入 Provider端： import ( "context" "log" "net" "github.com/cloudwego/kitex-examples/hello/kitex_gen/api" "github.com/cloudwego/kitex-examples/hello/kitex_gen/api/hello" "github.com/cloudwego/kitex/pkg/rpcinfo" "github.com/cloudwego/kitex/server" "github.com/kitex-contrib/registry-servicecomb/registry" ) type HelloImpl struct{} func (h *HelloImpl) Echo(_ context.Context, req *api.Request) (resp *api.Response, err error) { resp = &api.Response{ Message: req.Message, } return } func main() { // **初始化ServiceComb注册中心，默认从环境变量读取配置** r, err := registry.NewDefaultSCRegistry() if err != nil { panic(err) } svr := hello.NewServer( new(HelloImpl), server.WithRegistry(r), server.WithServerBasicInfo(&rpcinfo.EndpointBasicInfo{ServiceName: "Hello"}), server.WithServiceAddr(&net.TCPAddr{IP: net.IPv4(0, 0, 0, 0), Port: 8080}), ) if err := svr.Run(); err != nil { log.Println("server stopped with error:", err) } else { log.Println("server stopped") } } Consumer端： import ( "context" "log" "time" "github.com/cloudwego/kitex-examples/hello/kitex_gen/api" "github.com/cloudwego/kitex-examples/hello/kitex_gen/api/hello" "github.com/cloudwego/kitex/client" "github.com/kitex-contrib/registry-servicecomb/resolver" ) func main() { // **初始化ServiceComb注册中心，默认从环境变量读取配置** r, err := resolver.NewDefaultSCResolver() if err != nil { panic(err) } newClient := hello.MustNewClient( "Hello", client.WithResolver(r), client.WithRPCTimeout(time.Second*3), ) for { resp, err := newClient.Echo(context.Background(), &api.Request{Message: "Hello"}) if err != nil { log.Fatal(err) } log.Println(resp) time.Sleep(time.Second) } }

验证 部署成功后，登录微服务引擎控制台，在左侧导航栏选择“ServiceComb引擎专享版”，单击前提条件创建的ServiceComb引擎，选择“微服务目录”，单击微服务名称，在“实例列表”页签查看服务实例是否已经成功注册。 您也可以验证Consumer调用Provider能够正常调用。 设置环境变量serverAddr和serverPort为ServiceComb引擎服务注册发现地址的ip和port。 运行consumer。说明成功从ServiceComb引擎的服务中心获取了provider的ip和port，并调用了provider。

自定义统计采集 自定义统计采集(AppEvent)是自定义统计采集器，获取自定义统计相关信息。包括：类别、指标、指标名称、指标说明、单位、数据类型以及默认聚合方式。 表1 自定义统计采集(AppEvent)指标说明 指标类别 指标 指标名称 指标说明 单位 数据类型 默认聚合方式 自定义统计指标集(Event，自定义统计指标集相关信息。) total 自定义事件总次数 自定义事件总次数 - INT SUM k 自定义事件名 自定义事件名 - STRING LAST v 最后一次事件值 最后一次事件值 - STRING LAST avgV2 内容平均事件值 内容平均事件值 - DOUBLE AVG maxV2 内容最大事件值 内容最大事件值 - DOUBLE MAX minV2 内容最小事件值 内容最小事件值 - DOUBLE MIN 父主题： App

规则介绍 自动续费可以减少手动续费的管理成本，避免因忘记手动续费而导致AstroPro无法使用。自动续费的规则如下所述： 以AstroPro的到期日计算第一次自动续费日期和计费周期。 AstroPro自动续费周期，以您选择的套餐版本时长为准。 AstroPro到期前均可开通自动续费，到期前7日凌晨3:00首次尝试自动续费，如果扣款失败，每天凌晨3:00尝试一次，直至AstroPro到期或者续费成功。 开通自动续费后，还可以手动续费AstroPro。手动续费后，自动续费仍然有效，在新的到期时间前的第7天开始扣款。 自动续费的到期前7日自动扣款属于系统默认配置，您也可以根据需要修改此扣款日，如到期前6日、到期前5日等。 更多关于自动续费的规则介绍，请参见自动续费规则说明。

背景信息 在购买AstroPro后，如果发现当前规格套餐无法满足业务需求，您可以变更套餐规格。当需要变更到高规格套餐时，需补齐版本差价，剩余服务周期按照剩余天数（不含闰年的2.29号）/365 进行计算（变更当天不算） ，续费时按照变更后的版本进行续费。 升级版本费用 = 升级后版本价格 * 剩余周期 - 未升级版本价格 * 剩余周期 剩余周期计算：按照实际剩余有效期进行换算 示例：2023/11/1客户购买了3年的AstroPro，有效期截止到2026/11/1，客户在2024/5/1发生变更版本，则剩余周期=2024年剩余周期+2025年剩余周期+2026年剩余周期=244/365+1+305/365=2.50（年）。

计费说明 根据您选择的版本规格进行计费。购买专业版套餐后，计费项还包括扩容包。 表1 AstroPro计费项 计费项 计费项说明 适用的计费模式 计费公式 套餐规格 AstroPro提供了两种不同的规格套餐，请根据自身需求，购买相应的规格套餐。 基础版：满足个人及创业团队的基础需求，用户能够低门槛入门使用该产品。 专业版/企业版：提供了更多的应用及实体功能，可满足中大型企业的复杂管理需求。 包年/包月 套餐版本单价 * 购买时长 扩容包 扩容包用于新增更多的用户数、应用数和实体个数。扩容包不可单独购买和退订，扩容包的使用截止时间与主资源的截止时间保持一致，主资源套餐到期后，扩容包将不可使用。一个扩容包，包含用户数50个、应用数20个、实体个数200个。 包年/包月 扩容包单价 * 购买时长（以主套餐有效时间折算）

计费示例（无扩容包） 假设您在2023年11月01日，购买了AstroPro专业版有效期1年，并在到期前手动续费1年，则： 第一个计费周期为：2023/11/01 15:50:04 ~ 2024/11/01 23:59:59 第二个计费周期为：2024/11/01 23:59:59 ~ 2025/11/01 23:59:59 续费时需支付的费用为AstroPro规格套餐包年的费用（费用以官网实际费用为准）。

到期后影响 图1描述了AstroPro套餐包年/包月的各个阶段的状态。购买后，在计费周期内资源正常运行，此阶段为有效期。资源到期而未续费时，将陆续进入宽限期和保留期。 图1 包年/包月AstroPro套餐生命周期 到期预警 AstroPro套餐在包年/包月的到期前第7天内，系统将向用户推送到期预警消息。预警消息将通过邮件、短信和站内信的方式通知到华为账号的创建者。 到期后影响 当您包年/包月的AstroPro套餐到期未续费，首先会进入宽限期，资源状态变为“已过期”。宽限期内您可以正常访问AstroPro。 如果在宽限期内仍未续费AstroPro套餐，那么就会进入保留期，资源状态变为“已冻结”，您将无法对处于保留期的包年/包月AstroPro执行任何操作。 保留期到期后，若仍未续费，那么超过AstroPro基础版范围的功能会进入停用状态。

适用计费项 AstroPro提供了如下两种不同的规格套餐，供不同规模和管理需求的企业进行选购使用。希望通过合理的功能和服务的组合，为不同需求的客户，提供最合适的产品及服务内容。 基础版：满足个人及创业团队的基础需求，用户能够低门槛入门使用该产品。 专业版/企业版：提供了更多的应用及实体功能，可满足中大型企业的复杂管理需求。 表1 适用计费项 计费项 说明 套餐规格 套餐规格由用户数、服务数量和模型数量等组成。AstroPro套餐规格清单及功能介绍，请参见产品规格差异。

变更配置后对计费的影响 当前包年/包月AstroPro套餐的规格不能满足您的业务需要时，可以在控制台发起变更规格操作，变更时系统将按照如下规则为您计算变更费用： 套餐版本升级：新套餐版本价格高于老套餐版本价格，此时您需要支付新老版本的差价。 升级版本费用 = 升级后版本价格 * 剩余周期 - 未升级版本价格 * 剩余周期 剩余周期计算示例： 2023/11/1客户购买了3年的AstroPro，有效期截止到2026/11/1，客户在2024/5/1发生变更，则剩余周期=2024年剩余周期+2025年剩余周期+2026年剩余周期=244/365+1+305/365=2.50（年）。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json;charset=utf8”。 Authorization 是 String 认证凭据，值：Bearer {access_token}，access_token通过“获取访问凭据”接口获取。 表3 请求Body参数 参数 是否必选 参数类型 描述 code 是 String 角色代码，应用内唯一。 最大长度：50 name 否 String 角色名称。 最大长度：32

请求示例 根据应用id新增应用侧角色，角色代码为admin1,角色名称为管理员1。 POST https://{domain_name}/api/v2/tenant/applications/{application_id}/role Authorization: Bearer 334963fc-1e4a-473b-9096-52a929140... { "code": "admin1", "name": "管理员1" }

请求示例 修改用户，用户名zhangsan，手机号12345678901，邮箱zhangsan@example.com。 PUT https://{domain_name}/api/v2/tenant/users/{user_id} Authorization: Bearer 334963fc-1e4a-473b-9096-52a929140... { "user_name": "zhangsan", "org_code": "10000", "name": "zhangsan", "mobile": "12345678901", "email": "zhangsan@example.com", "employee_id": "123456789", "pwd_must_modify": false, "first_name": "F", "middle_name": "M", "last_name": "L", "attr_gender": "male", "attr_birthday": "1990-02-01", "attr_nick_name": "zhangsan", "attr_identity_type": "id_card", "attr_identity_number": "123456789", "attr_area": "CN", "attr_city": "xxx", "attr_manager_id": "123456789", "attr_user_type": "regular", "attr_hire_date": "2021-04-01", "attr_work_place": "xxx", "user_org_relation_list": [ { "orgCode": "10000", "relationType": 1 }, { "orgCode": "TestOrg1", "relationType": 0 }, { "orgCode": "TestOrg2", "relationType": 0 } ], "extension": { "age": "18" } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json;charset=utf8”。 Authorization 是 String 认证凭据，值：Bearer {access_token}，access_token通过“获取访问凭据”接口获取。 表3 请求Body参数 参数 是否必选 参数类型 描述 user_name 否 String 用户名，用户唯一标识，企业内唯一。 mobile 否 String 手机号，企业内唯一。 org_code 否 String 组织编码。 name 否 String 姓名。 email 否 String 邮箱。 employee_id 否 String 员工id。 first_name 否 String 名字。 middle_name 否 String 中间名。 last_name 否 String 姓氏。 pwd_must_modify 否 Boolean 首次登录是否需要强制修改密码。 缺省值：true attr_gender 否 String 性别。 枚举值： unknown：保密 male：男 female：女 attr_birthday 否 String 生日，格式为yyyy-mm-dd。 attr_nick_name 否 String 昵称。 attr_identity_type 否 String 证件类型。 枚举值： id_card：居民身份证 HongKong_Macau_Taiwan_residence_permit：港澳台居住证 mainland_travel_permit_for_HongKong_Macao：港澳居民来往内地通行证 mainland_travel_permit_for_Taiwan：台湾居民来往大陆通行证 chinese_passport：中国护照 overseas_passport：海外驾照 overseas_driver_license：海外驾照 officer_id：军官证 foreigner_residence_permit：外国人居留证 other：其他 attr_identity_number 否 String 证件号码。 attr_area 否 String 国家或者地区的编码。 attr_city 否 String 城市。 attr_manager_id 否 String 直属上级。 attr_user_type 否 String 人员类型。 枚举值： regular：正式 intern：实习 dispatch：劳务派遣 outsourcing：劳务外包 attr_hire_date 否 String 入职时间，格式为yyyy-MM-dd。 attr_work_place 否 String 工作地点。 user_org_relation_list 否 UserOrgRelationListOption object 用户组织关系集合。若填写，必须包含主组织的信息。 extension 否 Object 自定义扩展属性。 表4 UserOrgRelationListOption 参数 是否必选 参数类型 描述 orgCode 是 String 组织编码 relationType 是 String 归属关系，同一用户只能有1个归属，最多9个挂靠。 枚举值： 0：挂靠 1：归属

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json;charset=utf8”。 Authorization 是 String 认证凭据，值：Bearer {access_token}，access_token通过“获取访问凭据”接口获取。 表3 请求Body参数 参数 是否必选 参数类型 描述 role_id 是 String 角色id。 account_Ids 是 Array of strings 应用账号id集合，最大50条。

请求示例 根据应用id新增应用侧角色成员，角色id为20220420144449385-C66D-E8C1D1D79，应用账号id集合为[ "20220415171558023-84A4-ED5C390B8", "20220414163425614-2FD6-CA9B208BE" ]。 POST https://{domain_name}/api/v2/tenant/applications/{application_id}/role-member { "role_id" : "20220420144449385-C66D-E8C1D1D79", "account_Ids" : [ "20220415171558023-84A4-ED5C390B8", "20220414163425614-2FD6-CA9B208BE" ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 org_id String 应用机构id。 org_code String 应用机构编码。 name String 应用机构名。 parent_id String 父机构id。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误编号。 error_msg String 错误详情。

请求示例 创建一个用户，用户名zhangsan，手机号12345678901，邮箱zhangsan@example.com。 POST https://{domain_name}/api/v2/tenant/users Authorization: Bearer 334963fc-1e4a-473b-9096-52a929140... { "user_name": "zhangsan", "password": "p******d", "org_code": "10000", "name": "zhangsan", "mobile": "12345678901", "email": "zhangsan@example.com", "employee_id": "123456789", "pwd_must_modify": false, "first_name": "F", "middle_name": "M", "last_name": "L", "attr_gender": "male", "attr_birthday": "1990-02-01", "attr_nick_name": "zhangsan", "attr_identity_type": "id_card", "attr_identity_number": "123456789", "attr_area": "CN", "attr_city": "xxx", "attr_manager_id": "123456789", "attr_user_type": "regular", "attr_hire_date": "2021-04-01", "attr_work_place": "xxx", "user_org_relation_list": [ { "orgCode": "10000", "relationType": 1 }, { "orgCode": "TestOrg1", "relationType": 0 }, { "orgCode": "TestOrg2", "relationType": 0 } ], "extension": { "age": "18" } }

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json;charset=utf8”。 Authorization 是 String 认证凭据，值：Bearer {access_token}，access_token通过“获取访问凭据”接口获取。 表2 请求Body参数 参数 是否必选 参数类型 描述 user_name 是 String 用户名，用户唯一标识，企业内唯一。可在管理门户界面，用户菜单下的用户属性定义中修改必填属性。 password 否 String 密码，需要满足企业定义的格式。 mobile 是 String 手机号，企业内唯一。可在管理门户界面，用户菜单下的用户属性定义中修改必填属性 org_code 否 String 主组织的组织编码，填写企业中存在的组织编码。为空时组织在第一个根组织下。 name 否 String 姓名，为空值时设置为user_name。可在管理门户界面，用户菜单下的用户属性定义中修改必填属性。 email 否 String 邮箱。可在管理门户界面，用户菜单下的用户属性定义中修改必填属性。 employee_id 否 String 员工id。可在管理门户界面，用户菜单下的用户属性定义中修改必填属性。 first_name 否 String 名字。可在管理门户界面，用户菜单下的用户属性定义中修改必填属性。 middle_name 否 String 中间名。可在管理门户界面，用户菜单下的用户属性定义中修改必填属性。 last_name 否 String 姓氏。可在管理门户界面，用户菜单下的用户属性定义中修改必填属性。 pwd_must_modify 否 Boolean 首次登录是否需要强制修改密码。 缺省值：true attr_gender 否 String 性别。可在管理门户界面，用户菜单下的用户属性定义中修改必填属性。 枚举值： unknown：保密 male：男 female：女 attr_birthday 否 String 生日，格式为yyyy-mm-dd。可在管理门户界面，用户菜单下的用户属性定义中修改必填属性。 attr_nick_name 否 String 昵称。可在管理门户界面，用户菜单下的用户属性定义中修改必填属性。 attr_identity_type 否 String 证件类型。 枚举值： id_card：居民身份证 HongKong_Macau_Taiwan_residence_permit：港澳台居住证 mainland_travel_permit_for_HongKong_Macao：港澳居民来往内地通行证 mainland_travel_permit_for_Taiwan：台湾居民来往大陆通行证 chinese_passport：中国护照 overseas_passport：海外驾照 overseas_driver_license：海外驾照 officer_id：军官证 foreigner_residence_permit：外国人居留证 other：其他 attr_identity_number 否 String 证件号码。 attr_area 否 String 国家或者地区的编码。 attr_city 否 String 城市。 attr_manager_id 否 String 直属上级。 attr_user_type 否 String 人员类型。 枚举值： regular：正式 intern：实习 dispatch：劳务派遣 outsourcing：劳务外包 attr_hire_date 否 String 入职时间，格式为yyyy-MM-dd。 attr_work_place 否 String 工作地点。 user_org_relation_list 否 Array of UserOrgRelationListOption objects 用户组织关系集合。若填写，必须包含主组织的信息。 extension 否 Object 自定义扩展属性。 表3 UserOrgRelationListOption 参数 是否必选 参数类型 描述 orgCode 是 String 组织编码 relationType 是 String 归属关系，同一用户只能有1个归属，最多9个挂靠。 枚举值： 0：挂靠 1：归属

请求示例 微信登录。微信应用提供的授权码为ad12sasdsfe3dfdg3sc。 POST https://{domain_name}/api/v2/sdk/login/wechat X-operating-sys-version: Android 10 X-device-fingerprint: 156aysdna213sac X-device-ip: 10.10.10.1 X-agent: Mozilla/5.0 (Linux; Android 10; Redmi K30 Build/QKQ1.190825.002; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/80.0.3987.99 Mobile Safari/537.36 X-L: zh X-client-id: DRrYIqauawN0I8myTMoDTPys6ezGZxnm X-tenant-id: 08f770f51f80d2f40f38c00cb199fd21 { "code": "ad12sasdsfe3dfdg3sc" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 status String 登录流程状态标识。 枚举值： SUC CES S：登录成功 SOCIAL_BIND：绑定流程，需要调用验证码和社交账号登录绑定手机号相关接口完成绑定流程 USER_REGISTER：自动注册绑定流程，需要调用验证码和社交账号注册并绑定手机号相关接口完成注册绑定流程 ACCESS_DENIED：拒绝访问 MFA_AUTH：登录成功但需要进行二次认证，需要调用验证码和二次认证相关接口进行二次认证 session_token String 用户session_token，可使用该token调用单点登录接口获取sso_ticket，通过sso_ticket可以获取用户信息。 id_token String 本质上是一个JWT Token，包含了用户身份信息，默认2小时有效，支持可配置。 expire Integer session_token有效期，单位为秒，有效期内可以使用session_token获取sso_ticket。 state_token String 用户带有状态的令牌。 data String 返回说明。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误详情。