华为云用户手册

数据保护技术 开天工业工作台通过数据保护手段，保障开天工业工作台数据可靠性。 表1 开天工业工作台的数据保护手段 数据保护手段 简要说明 传输加密（HTTPS） 开天工业工作台外部接口支持HTTPS传输协议，保障数据传输的安全性。 服务端加密 开天工业工作台涉及个人数据处理，包括姓名、手机号码、邮箱等。这些数据在开天工业工作台内加密存储，避免个人数据的泄露。 数据容灾保护 开天工业工作台内的数据，包括RDS（Relational Database Service）、D CS （Distributed Cache Service），启用了定时备份机制，定时全量备份（默认每天）与增量备份（默认5分钟）。 同时，RDS、DCS启用了双AZ（Availability Zone）容灾，当一个AZ异常后，可以无缝切换到另一个AZ上继续使用。 父主题： 安全

计费说明 开天工业工作台业务规格类型分为专业版基础型、专业版标准型、专业版增强型。 表1 专业版基础型 业务规格类型 规格描述 详细规格 计费模式 专业版基础型 用户数 用户数100个。 包年 办公应用 IM即时消息、日历、通讯录、审批、待办中心、新闻资讯、企业公告。 应用管理 统一组织、统一账号、统一授权、统一登录、应用分组管理、支持企业在华为云的自建应用对接。 门户应用 默认门户 定制门户 应用集成 支持集成流编排和运行（40条流）。 知识管理 数字化诊断工具。 表2 专业版标准型 业务规格类型 规格描述 详细规格 计费模式 专业版标准型 用户数 用户数500个。 包年 办公应用 IM即时消息、日历、通讯录、审批、待办中心、新闻资讯、企业公告。 应用管理 统一组织、统一账号、统一授权、统一登录、应用分组管理、支持企业在华为云的自建应用对接。 门户应用 默认门户 定制门户 应用集成 支持集成流编排和运行（80条流）。 知识管理 数字化诊断工具。 专业版基础型和专业版标准型支持订购扩容包，1个扩容包包含100个用户数和10条集成流。 表3 专业版增强型 业务规格类型 规格描述 详细规格 计费模式 专业版增强型 用户数 用户数1000个。 包年 办公应用 IM即时消息、日历、通讯录、审批、待办中心、新闻资讯、企业公告。 应用管理 统一组织、统一账号、统一授权、统一登录、应用分组管理、支持企业在华为云的自建应用对接。 门户应用 默认门户 定制门户 应用集成 支持集成流编排和运行（200条流）。 知识管理 数字化诊断工具。

关键特性 工业云商城：打造工业企业的数字化商店，精准的解决方案匹配，打造行业数字化标杆。 工业工作台：企业一站式信息服务及数字化管理平台。 一个账号访问所有服务：简化IT服务使用门槛，统一权限管理和应用管理。 随时随地处理业务：跨终端账号和数据协同，移动办公不受地域限制。 一站式使用数字服务：一个入口访问所有IT服务，用户自动获取数字服务。 打造行业专属桌面：企业Logo、桌面菜单自定义，积木式搭建企业办公桌面。 数据采集：轻量化大数据分析服务。 数据集成：沉淀行业应用集成资产。 应用集成只对接一次，可提升集成效率30%+。 提供行业API开放服务，提供人工智能、行业标识等基础能力。标准 API服务 已达到1000+。 聚合应用集成资产，连接器封装工业应用南向和北向接口，连接流串联连接器。 数据运营：可视化报表展示，监控企业核心业务指标。 协同办公：IM、日历、通讯录、审批、待办、新闻、公告。

应用场景 开天工业工作台是面向中小型制造业定制的一站式数字化解决方案。涵盖业务数字化的管理工具（销售订单管理、库存管理等）、企业业务流程工具（ERP、MES、业务互通）、定制化企业门户、常用协同办公能力、应用统一管理、应用集成和数据互通等能力。支持企业多业务场景管理，为企业打通上下游业务流。提供开箱即用的应用、低成本高回报、解决各种业务痛点，助力企业轻松上云。 业务数据化管理，帮助企业解决四大业务痛点。 快速掌握企业的全面销售情况： 图1 销售情况 对比去年同期与公司整体销售额。 对比区域销售额与客户销售额。 对比业务员业绩。 分析重点客户销售。 分析主要产品销售。 快速掌握企业订单情况，按时交付： 图2 订单情况 打开移动端app可快速查询客户订单状态。 企业及时处理超期订单。 从客户、产品维度了解订单交付情况。 通过报表分析提升企业准交率。 快速掌握企业库存物料呆滞程度： 图3 库存物料呆滞程度 快速查看库存总金额与呆滞金额比重。 分析每月呆滞物料变化情况。 分析不同仓库的物料积压程度。 快速掌握企业工厂生产效率： 图4 生产效率 企业实时产量报表。 工人手机派工、报工。 统计工人生产绩效。 三大业务工具：为企业提供ERP、MES主流工业应用和应用互通工具。 应用间业务互通： 基础资料同源：在ERP中维护的物料信息，可以在MES录入工单时被使用。 业务流的数据互通：在ERP中录入的销售订单，可以在MES录入工单时，通过来源单据被选到。 可视化报表展示与ERP数据的同步。

修订记录 发布日期 修订记录 2024-01-10 第七次正式发布。计费说明删除“基础版”业务规格类型。 2023-09-28 第六次正式发布。 优化如下章节： 计费说明 2023-02-17 第五次正式发布。 优化如下章节： 图解开天工业工作台 应用场景 2023-01-17 第四次正式发布。 新增如下章节： 图解开天工业工作台 优化如下章节： 计费说明 2023-01-03 第三次正式发布。 优化如下章节： 计费说明 2022-12-15 第二次正式发布。 优化如下章节： 计费说明 约束与限制 2022-12-08 第一次正式发布。

产品功能 开天工业工作台产品功能如表1所示。 表1 开天工业工作台功能概览 功能 简介 工作台配置 工作台提供门户、移动门户的定义，门户可以通过行业管理员或者企业管理员来定义（二级门户定义），行业管理员定义的门户将默认被企业继承。 工作台提供登录页定义的能力，登录页设置包括：网站Logo、登录页背景、登录页标题等。 门户管理 工作台的门户由三个部件组成：门户站点、首页和导航菜单。当前系统提供几种默认布局，支持企业管理员新建或复制一个已存在的站点，并对站点的布局进行更改。首页由企业管理员根据已有模板进行复制更改或者新建。 统一账号 企业管理员自注册：企业管理员账号拥有对企业所有组织结构和用户、应用、管理门户菜单的管理权限。 账号管理：自动为用户添加应用账号，提供账号的注册、密码重置、禁用等功能。 账号首登密码强制修改：支持判断是否是首次登录，如果是首次登录，会要求用户强制更改初始密码。 账号登录日志查询：业务管理员或者企业管理员可以通过账号登录日志界面查看登录日志。登录日志中显示账号、用户名、登录时间、IP、账号状态等信息。 统一组织 部门管理：企业管理员管理本企业部门结构，支持手动创建或导入创建。 成员管理：企业管理员为部门添加成员，添加后将自动生成登录账号。成员添加有直接添加和成员邀请两种模式，其中成员邀请可通过邀请码、二维码和URL三种方式邀请。 权限管理：企业管理员可以通过创建角色并将角色赋予企业成员来分配管理权限。 统一登录 提供统一登录认证、应用间账号的免登录、账号登录日志、账号密码重置等相关功能。 统一授权 统一管理企业自建应用和在云市场采购的应用，并对应用进行统一授权管理。 企业向服务提供商主动授权用户数据，涉及手机号、邮箱等。 应用管理 应用分为四类：内置应用、预装应用、订阅应用、自建应用。 内置应用： 企业工作台 预置的应用，如审批、日程、待办中心等。 预装应用：预装应用包括联邦应用和SaaS应用，由系统配置，配置完成后即可使用。 订阅应用：由企业管理员或者拥有企业采购能力的员工通过云市场订单订购而来。 自建应用：企业内IT自建的应用或者通过 集成工作台 发布的企业内应用。 应用管理包括：应用详情查看、应用分组、跳转云市场（查看市场应用并订购）。 实例管理 企业开通开天工业工作台后，开天工业工作台会给企业分派默认三级 域名 ，并为企业绑定预装的应用列表。企业可以查看用户登录和管理侧的登录地址，并能跳转到管理后台对企业进行管理操作。 运营运维 运营管理：开天工业工作台提供基础企业运营相关数据，支持管理员查看到企业的基本信息，包括：企业名称、企业简介、企业联系人、企业联系方式、企业的组织数、当前用户数、已激活用户、订阅的应用数等信息。 运维管理：开天工业工作台基于高可靠的部署和组网，支持主备容灾。 新闻管理 新闻管理的一个重要功能是分类管理，通过对发布的新闻进行分类，可实现对应的权限管控、展示不同字段内容信息。发布的新闻会推送给企业内所有成员，也可以置顶显示。 多端能力 工作台提供多种形式客户端，支持用户使用统一的账号通过Web浏览器、PC端和移动端登录。

应用类型 按照是否独占云服务资源，应用分为两种类型：共享域名和独立域名。 共享域名应用：不同客户使用相同的网站域名登录。一般而言，软件即服务SaaS应用，不同企业均共享统一的云基础设施环境，使用共享域名的情况居多。 独立域名应用：不同客户使用不同的网站域名登录。一般而言，每个企业独立一套部署环境的应用。由于IP地址不同，只能使用独立域名，少部分SaaS应用也会给企业分配独立域名。 父主题： 基本概念

权限管理 表1 开天工业工作台权限管理 权限名称 描述 依赖关系 企业管理员 开通开天工业工作台时自动创建的企业管理员，是企业内拥有最高权限的管理员，可对企业内的门户、组织成员（通讯录）、应用、权限、角色、新闻、公告及企业信息等内容进行管理。 无 业务管理员 由企业管理员在开天工业工作台角色权限处创建，拥有对企业部分门户、组织成员（通讯录）、应用的管理权限。 企业管理员 普通用户 具体使用开天工业工作台的人员，一般是由企业管理员或业务管理员在管理后台添加，添加完成后，用户账号自动开通，可登录开天工业工作台。 无

技术优势 实现应用统一账号、统一登录、统一鉴权、统一组织信息，提供统一接入规范。涉及领域包括ERP、CRM、PLM、OA、IoT、BI、MES、CAD、SRM、生产培训、知识管理等。 行业资产库，丰富的行业API、连接器、流模板、卡片、数据集等，使能业务创新，缩短应用上线时间。 预置行政人事轻应用，后台数据打通：预装即时消息、待办、公告、日历、行政服务、人事管理等基础应用，打通应用间数据关联，实现开箱即用，企业业务一站启航。 数据模型驱动开发和集成：具备数据模型定义能力，具备基于数据模型驱动的应用开发和集成能力，包含研、产、供、销、服各大领域通用数据资产模型，基于数据模型可以快速构建轻应用和快速集成轻应用。 门户自定义编排，打造企业专属阵地：提供丰富的模板组件，自定义工作台门户；更换登录页的图片及Logo，匹配企业个性化需求。灵活配置企业门户，支持企业门户自定义，同时支持产业集群运营门户，满足企业运营需求。 数据集成零码/低码平台： 连接器实现了集成工作台流编排能力扩展，预置丰富的连接器，还为用户提供自定义连接器能力。 业务流编排：通过可视化的方式对连接器进行组合、编排，支持流程编排，事件编排等。 IoT边缘集成：支持对接IoT边缘通道，支持IoT数据对接。 集成资产积累：支持预集成资产积累，支持ERP、CRM、PLM、OA、IoT、BI、MES、CAD、SRM间数据快速集成，相比传统集成开发速度提升5倍以上。 组织、用户、应用多维度管理： 精细化管理，应用使用权限可细化到组、人和部门。 用户分组分角色管理。 企业内组织的统一管理配置，多处复用。 无需跳转，应用一站使用：工作台预装的办公应用、企业自建应用、用户在云市场购买的应用，均可在工作台快速打开使用，无需二次登录，提高办公效率。 父主题： 产品优势

身份认证与访问控制 身份认证 开天工业工作台提供了两种身份认证登录方式，未授权的用户不能访问： 企业管理员可以使用华为云用户名与密码登录华为云，通过华为云企业工作台SSO登录开天工业工作台的管理后台。 企业员工可以使用员工的用户名与密码登录开天工业工作台，如果是管理员，可以再跳转到管理后台。 访问控制 企业管理员可以通过设置员工的访问权限和业务管理员角色来管理开天工业工作台。 企业员工只能在企业管理员设置的权限下使用开天工业工作台。 父主题： 安全

服务韧性 开天工业工作台提供了3级可靠性架构，通过双AZ容灾、AZ内集群容灾、数据容灾技术方案，保障服务的持久性与可靠性。 表1 开天工业工作台可靠性架构 可靠性方案 简要说明 跨AZ容灾 开天工业工作台实现AZ双活，一个AZ异常时，另一个AZ为云服务持续提供服务。 AZ内集群容灾 开天工业工作台通过集群提供服务，集群中每个微服务都有多个实例，当一个或部分实例异常时，其他实例可以持续提供服务。 数据容灾 开天工业工作台数据存储在RDS、DCS服务中，RDS、DCS实现了AZ容灾方案，数据持续会同步到容灾站点，当生产站点的RDS异常后，容灾站点可以接管业务，保障云服务持续运行。 父主题： 安全

产品价值 作为SaaS（Software as a Service）应用分发平台，开天工业工作台助力企业数字化转型，加速新技术应用和业务创新，面向工业企业提供的主要价值包括： 一个账号登录企业应用：开天工业工作台提供统一账号认证服务，企业用户切换不同应用时，无需重复输入密码，大幅提升了工业企业应用间协同效率。 工业应用推荐服务：开天工业工作台基于华为云市场海量的应用资源，构建工业应用分发平台，根据企业行业特点实现供需匹配，方便工业企业获取满足业务需要的应用。 门户自定义编排，打造企业专属阵地：提供丰富的模板组件，自定义工作台门户；更换登录页的图片及Logo，匹配企业个性化需求。 组织、用户、应用多维度管理：精细化管理，应用使用权限可细化到组、人和部门；用户分组分角色管理；企业内组织的统一管理配置，多处复用。 预置行政人事轻应用，后台数据打通：预装即时消息、待办、公告、日历、行政服务、人事管理等基础应用，打通应用间数据关联，实现开箱即用，企业业务一站启航。 业务敏捷按需开发：依托开天工业工作台自带的 低代码开发平台 ，预置大量开发模板，支持业务人员以积木拼接的方式，快速构建行业应用和企业经营看板，满足企业内部80%以上应用开发需求，加速业务创新。 工业解决方案：工业解决方案预集成多个工业应用和华为云服务，以SaaS服务形式提供细分的场景解决方案，用户无须关心方案的构建细节，只需聚焦业务场景和应用使用效果。 以上用户价值需要应用生态协同才能达成，为更好的支持生态伙伴发展，开天工业工作台为伙伴也提供了许多高价值服务： 云技术协同创新：依托开天工业工作台，为伙伴应用提供大数据、AI、物联网等云原生基础技术能力，加速伙伴应用创新。 市场联合拓展：和应用伙伴联合拓展 工业互联网 市场，依托本地化技术团队，协助应用伙伴解决前期获客、中期交付和后期服务的难题。 专业集成验证：为伙伴应用与开天工业工作台的集成提供专业的技术咨询和集成验证服务，一次验证，华为云生态通用，避免反复集成验证，同时基于开天工业工作台确保验证和生产环境的一致性。 交付效率提升：基于开天工业工作台提供标准客户服务支持，应用生态伙伴聚焦项目交付实施投入，减少服务人员投入；随着交付经验的积累，开天工业工作台支持通过应用编排和部署工具，将交付实施工作标准化、自动化，大幅提升交付实施效率。 多应用高效集成：开天工业工作台提供的API集成、数据共享基础能力，大幅降低应用间集成开发难度，实现了数据在应用间的无缝流转，面向用户提供整体解决方案。 父主题： 产品优势

TDIS权限 默认情况下，新建的 IAM 用户没有任何权限，您需要将其加入用户组，并给用户组授予策略或角色，才能使得用户组中的用户获得对应的权限，这一过程称为授权。授权后，用户就可以基于被授予的权限对云服务进行操作。 TDIS部署时通过物理区域划分，为项目级服务。授权时，“作用范围”需要选择“区域级项目”，然后在指定区域（如华北-北京4）对应的项目（cn-north-4）中设置相关权限，并且该权限仅对此项目生效；如果在“所有项目”中设置权限，则该权限在所有区域项目中都生效。访问TDIS时，需要先切换至授权区域。 如下表所示，包括了TDIS的所有系统权限。 表1 TDIS系统权限 系统权限 权限描述 权限类别 说明 Tenant Administrator 全部云服务管理员（除IAM权限） 系统角色 详情请参考系统权限。 Tenant Guest 全部云服务只读权限（除IAM管理权限） 系统角色

方案优势 完备的身份和认证管理 随着数字社会的发展，数字身份得到越来越多的使用。传统的身份管理中，身份颁发和获取依赖中心化的第三方，无法实现身份的自主可控、自解释。同时身份的可移植性差。TDIS服务可提供完备的身份管理和认证凭证管理。 强数据隐私保护 分布式场景下用户通过出示凭证获得相应的权限和权益。但凭证出示粒度较粗，隐私保护能力较差，在出示验签的过程中导致用户无关属性暴露。TDIS服务提供强数据隐私保护能力，保障证照应用中的证照数据可用不可见。 丰富易用的扩展组件 证照应用中凭证多种多样，难于管理和维护。凭证模板管理组件可以提将证照统一化、标准化。屏蔽底层 区块链 用户接入门槛，可快速集成分布式身份构建业务。

产品优势 分布式身份系统 遵循W3C的 Decentralized Identifiers(DIDs)v1.0 和 Verifiable Credentials(VC)v1.0 标准规范实现。系统扩展性强，支持身份和可验证凭证的全流程链上管理能力。 强数据隐私保护 可验证凭证支持基于属性级别的细粒度出示，凭证使用者可根据隐私保护需要，任意组合出示凭证中的属性给验证者完成验证，最大程度保护用户隐私，同时解除了已签发凭证对应用业务场景的限制。 凭证申请和签发的相关材料全链路加密存储，使数据可用不可见。 丰富的扩展组件 提供凭证模板管理、链下凭证签发、密钥托管等扩展功能组件，帮助用户基于分布式身份快速构建应用，无须购买和管理区块链资源。

使用方式 根据持有者申请可验证凭证的方式，将可信分布式身份服务的使用分为链外申请模式和链上申请模式。 链外申请模式中，持有者将申请可验证凭证的身份/凭证数据直接发送给签发者。 链上申请模式中，持有者将申请可验证凭证的身份/凭证 数据加密 存储于区块链。 图2 可信分布式身份使用时序图(链外申请模式) 链上申请模式中，根据持有者与签发者之间是否需要通信信道，分为在线申请和离线申请。 图3 可信分布式身份使用时序图(链上申请-在线申请模式) 图4 可信分布式身份使用时序图(链上申请-离线申请模式)

响应提取 响应提取是提取接口响应结果的某一部分，命名为参数，供后续测试步骤参数化调用。响应提取需要在前序测试步骤定义，后续测试步骤使用。 在前序测试步骤中，在“响应提取”页签创建要传递的参数。响应提取来源用到内置参数，请参考内置参数了解如何使用内置参数。响应提取同时支持正则表达式的匹配，提取出与给定正则表达式匹配的返回值。 在后续测试步骤中，通过“${参数名}”方式引用前序测试步骤创建的响应提取。后续步骤的URL、请求头、请求体中均可以引用此参数。如果在JSON格式的请求体中引用此参数，请在参数外使用英文引号，如： { id: "用例ID" name:"${name}" } 响应提取支持根据给定的“key:value”获取字符串，详细配置可参考示例：根据给定的key:value从响应体中获取字符串。 字段 说明 出参名称 用于之后使用${出参名称}来引用此参数，名称使用字母数字下划线。 来源 被检测字段的来源，如响应体（JSON）、响应头、响应码。 属性 若来源是响应码，属性为空。详细介绍请参见响应码检查。 若来源是响应头，属性为响应头中字段的名称。详细介绍请参见响应头检查。 若来源是响应体（JSON），属性有两种填写方法： 普通提取表达式（非“$”开头），例如“item.name”。 取字段中的值，支持嵌套取值。详细介绍请参见响应体（JSON）检查。 从响应体中提取数组时，下标可以是数字，也可以是“key:value”表达式，详细介绍请参见示例：根据给定的key:value从响应体中获取字符串。 JsonPath表达式(“$.”或“$[”开头)，例如“$.store.book[0].title”。 详细介绍请参见示例：根据JsonPath从响应体中获取数据。 高级提取类型 可选项，使用高级提取类型，辅助提取响应结果信息，若选择不涉及则视为不使用额外的方式匹配。 目前有两种方式： 字符串提取，也就是字符串的截取。 正则表达式，即使用正则方式对来源字符串进行过滤。 高级提取类型优先使用字符串提取功能，若不能满足需求可考虑使用正则表达式。 赋值给环境动态参数 将响应提取后的值赋值给动态变量，用于后续测试引用。请参考新建变量，如何设置动态变量。 父主题： 测试用例管理

与 区块链服务BCS 的关系 区块链服务（Blockchain Service简称 BCS ）是面向企业及开发者提供的区块链技术服务平台，它可以帮助您快速部署、管理、维护区块链网络，降低您使用区块链的门槛，让您专注于自身业务的开发与创新，实现业务快速上链。 分布式身份服务TDIS依赖区块链服务BCS。用户无需在区块链服务BCS购买区块链，可直接开通TDIS服务使用基于BCS服务构建的可信分布式身份服务。实现分布式身份和可验证凭证的生成、申请、签发等管理能力，以及数据的发布、授权、分享、解密等能力。

基本概念 分布式身份(Decentralized Identity, DID)：一种新型的标识符，可实现可验证的、去中心化的数字身份。 可验证凭证(Verifiable Credential, VC): 一种可验证具备防篡改能力的数字化凭证。包含物理凭证可代表的所有信息，签发机构(者)相关信息、凭证类型信息(驾照、保险卡)、凭证声明属性信息(出生日期、国籍)、凭证限制相关信息(过期时间、使用条款)、凭证所有者信息(身份证号、did标识、姓名)等等。 签发者(Issuer): 分布式身份系统中的角色之一，根据业务逻辑验证后，负责签发可验证凭证。 持有者(Holder): 分布式身份系统中的角色之一，根据业务需要可向签发者申请可验证凭证，向验证者出示已持有的可验证凭证。 验证者(Verifier): 分布式身份系统的角色之一，可校验持有者出示的可验证凭证，用于支撑后续业务决策。 每个did可以是设备、应用、组织或者个人。每个did身份可以同时是签发者、持有者或者验证者角色。

对于响应的处理 pm.response 在后置脚本中pm.response接口请求完成后返回响应信息，Response SDK 参考。 response包含了以下结构： pm.response.code:Number：获取响应码。 pm.response.status:String：获取响应状态。 pm.response.headers:HeaderList：获取响应头。 pm.response.responseSize:Number：获取响应大小。 pm.response.text():Function：以文本形式输出响应体。 pm.response.json():Function：以json形式输出响应体。 pm.response.setBody('')：设置响应体。 pm.response.headers.get：从响应头中获取指定参数的值，Response SDK 参考。 后置脚本中使用“pm.response.headers.get”命令可以获取响应头中指定参数的值。例如想要获取响应Header中date参数的值，那么可以在后置操作中输入如下自定义脚本： var test = pm.response.headers.get("date");console.log(test);

对于发送请求的处理 pm.sendRequest pm.sendRequest:Function用于脚本异步发送HTTP/HTTPS的请求。 更多参数信息请查阅Collection SDK 文档 。 在前置脚本和后置脚本都可以使用。 更多参考: Request JSON 结构 Response 结构 // 使用字符串URL示例pm.sendRequest("https://postman-echo.com/get", function(err, resq) { if (err) { console.log(err); } else { pm.variables.set("variable_name", "new_value"); }});// 完整请求示例const echoPostRequest = { url: "https://postman-echo.com/post", method: "POST", header: { header_name1: "value1", header_name2: "value2", }, // body 为 x-www-form-urlencoded 格式 body: { mode: "urlencoded", // 此处为 urlencoded // 此处为 urlencoded urlencoded: [ { key: "account", value: "codeartsapi" }, { key: "password", value: "123456" }, ], }, /* // body 为 form-data 格式 body: { mode: 'formdata', // 此处为 formdata // 此处为 formdata formdata: [ { key: 'account', value: 'codeartsapi' }, { key: 'password', value: '123456' } ] } // body 为 json 格式 header: { "Content-Type": "application/json", // 提醒：header中需要添加Content-Type }, body: { mode: 'raw', raw: JSON.stringify({ account: 'codeartsapi', password:'123456' }) } // body 为 raw 或 json 格式 body: { mode: 'raw', raw: 'body内容' } */};pm.sendRequest(echoPostRequest, function(err, resq) { console.log(err ? err : resq.json());});// 对返回结果进行断言pm.sendRequest("https://postman-echo.com/get", function(err, resq) { if (err) { console.log(err); } pm.test("response should be OK to process", function() { pm.expect(err).to.equal(null); pm.expect(resq).to.have.property("code", 200); pm.expect(resq).to.have.property("status", "OK"); });});

对于请求的处理 pm.request pm.request对象可以在脚本中对请求数据进行访问，Request SDK 参考。在前置脚本中表示即将运行的请求，在后置脚本中，表示已经运行的请求。 pm.request包含了以下结构： pm.request.url:Url：获取当前请求的URL。 pm.request.getBaseUrl()：获取运行中环境选择的前置URL。 pm.request.method:String：获取当前请求的方法，如GET、POST等。 pm.request.headers:HeaderList：获取当前请求的headers列表。 pm.request.body:RequestBody：获取当前请求的body体。 pm.request.headers.add({ key: headerName:String, value: headerValue:String}):function：为当前请求添加指定键和值的header。 pm.request.headers.remove(headerName:String):function：删除当前请求里指定键的header。 pm.request.headers.get(headerName:String):function：获取请求里指定名称的header。 pm.request.headers.upsert({ key: headerName:String, value: headerValue:String}):function：插入指定键和值的header（如果header不存在则新增，如果header已存在则修改）。 pm.request.auth：获取请求的身份验证信息。

pm pm:Object pm对象，含有接口运行关联信息。可利用它获取或设置环境变量和全局变量，且访问请求信息和返回结果信息。 pm:info:Object pm.info对象，含有接口运行关联信息。 pm.info.eventName:String：获取当前执行的脚本类型：前置脚本（prerequest），后置脚本（test）。 pm.info.iterationCount:Number：返回执行循环的总次数，仅集合测试有效。 pm.info.iteration:Number：获取当前执行循环（iteration）次序，仅集合测试有效。 pm.info.requestId:String：获取运行中接口用例的唯一ID。 pm.info.requestName:String：获取运行中接口用例名称。

使用方式 /** * 示例一：该示例引入加密算法模块 crypto-js，并使用其中 AES 对 message 进行加解密 * @param message 需要加密的文本 * @param key 秘钥 */function cryptoJSTest(message, key) { const CryptoJS = require('crypto-js'); // 加密 const ciphertext = CryptoJS.AES.encrypt(message, key).toString(); // 解密 const bytes = CryptoJS.AES.decrypt(ciphertext, key); const originalText = bytes.toString(CryptoJS.enc.Utf8); console.log(originalText);}cryptoJSTest('test message', 'secret key');/** * 示例二：该示例引入 uuid 模块生成一段 uuid，并引入 btoa 模块进行 Base64 编码 */function uuidBtoaTest() { const uuid = require('uuid'); const btoa = require('btoa'); const id = uuid.v4(); const base64EncodedId = btoa(id); console.log(id); console.log(base64EncodedId);}uuidBtoaTest();/** * 示例三：该示例引入 lodash 模块，并测试了其中的 uniq 对数组去重 */function lodashUniqTest() { const lodash = require('lodash'); const arr =[1, 2, 1, 5, 1, 9] const uniqArr = lodash.uniq(arr); console.log(uniqArr.toString())}lodashUniqTest();

内置类库列表 断言 chai （v4.2.0）：用于断言BDD/TDD断言。 加密解密库 jsrsasign（10.3.0）：用于RSA加密/解密。 Encode、Decode 库 crypto-js（v3.1.9-1）：编码/解码库，基本包含常用的编码、解码方式，如Base64、MD5、SHA、HMAC、AES等等。 require方法只允许使用整个模块，不能单独使用类库里的某个子模块，具体看本文档末尾说明。 atob（v2.1.2）：用于Base64解码。 btoa（v1.2.1）：用于Base64编码。 tv4（v1.3.0）：用于校验JSONSchema。 xml2js（v0.4.19）：用于XML转JSON。 JSONSchema校验库 ajv（v6.6.2）：校验JSONSchema。 实用工具 postman-collection（ v3.4.0）：Postman Collection库。 cheerio（v0.22.0）：jQuery的子集。 lodash （v4.17.11）：JS实用工具库。 uuid ：生成UUID。 moment（v2.22.2）：日期处理库 (不含 locales)。 mockjs：模拟数据生成，拦截Ajax请求。 csv-parse/lib/sync（ v1.2.4）：处理CSV格式数据。 iconv-lite：用于字符编码转换，支持数十种字符编码格式的转换。 内置NodeJS模块 path：处理文件路径。 assert：提供一组断言测试。 buffer：处理二进制数据。 util：实用函数的集合。 url：解析URL字符串。 querystring：处理URL，查询字符串。 punycode：字符编码方案。 string-decoder：将Buffer对象解码为字符串。 stream：处理流数据。 events：处理事件。 timers：在给定的毫秒数后调用函数。 通过require方法可以直接使用CodeArts API内置的JS类库。 var cryptoJs = require("crypto-js");console.log(cryptoJs.SHA256("Message"));

接口路径 API调试页面的接口路径，可以选择http或https，并在定义的路径前自动添加了域名。添加的域名是在右上角选择的环境参数中定义的，单击左侧下拉箭头可在不同运行环境间切换，单击下拉箭头右上角按钮，可进行环境参数配置。 针对各个环境，默认提供变量“hostURL”参数作为添加到接口前的域名，从而拼接成完整地址。 可以看到对应环境“默认环境”中的“hostURL”参数的值“127.0.0.1:8080”被添加到接口URL前，作为整个路径的域名。鼠标悬浮在路径前，提示此前置URL来自于哪一环境，单击环境名称，可直接跳转至相应环境下进行编辑。 路径中大括号“{}”中的字符串表示Path参数。 路径中“?”后的字符串表示Query参数。 如果在调试页面路径栏下方的Query属性框中，对Query参数进行修改，路径中的Query参数也会同步变化。

请求体 在Body页签中，可以查看请求体，目前支持的请求体有如下几类： none：无body参数。 form-data：Content-Type为“multipart/form-data”，可以输入请求体中每个参数的类型、名称和值。 application/x-www-form-urlencoded：Content-Type为“application/x-www-form-urlencoded”，可以输入请求体中每个参数的名称和值。 raw：在文本框中输入文本内容，在“raw”选项旁边可以下拉选择输入文本内容格式，如Text和Json。 请求参数的默认值均来自API设计的样例值。 在API调试页面修改请求参数，不能保存至API设计与API文档中。

背景介绍 随着微服务系统及分布式架构的发展，多模块或子系统的依赖为软件系统的开发与测试带来了很多挑战。比如在测试某个模块时，依赖的第三方服务不能返回想要的结果，或第三方服务不稳定时，该模块的测试进度则会受到影响。 Mock服务能很好解决这些问题，使用场景如下： 并行开发：在被依赖模块未开发完成时，使用Mock服务替代真实业务服务场景，可进行并行开发。 依赖服务不稳定：当依赖服务不稳定时，会导致自动化测试用例失败，使用Mock服务替代真实服务，可以保证自动化测试稳定执行，提升流水线的健壮性。 构造异常场景：测试时需要构造某些异常数据或延迟响应等异常场景，真实服务通常无法满足需求，使用Mock服务替代可以快速构造异常场景，提升测试覆盖率。 前后端分离开发：前端开发往往依赖于后端数据接口，在后端接口就绪之前，前端往往很难推进，前端可以通过Mock功能制造场景数据接口来进行开发与调试。 父主题： API Mock

Markdown设计 新建Markdown，可通过以下三种方式完成。 方法一：单击目录树搜索框右侧的，在弹出的下拉框中，选择“新建Markdown”。 方法二：在目录树中选择一个目录，单击右侧图标，在弹出的下拉框中，选择“新建Markdown”。 进入“新建标签页”，在该标签页可以编辑Markdown文件，主要包括：目录、名称、正文。 目录：在上一步中，如果通过方法一和方法二新建Markdown，目录初始内容为空，可以手动选择；如果通过方法三新建Markdown，目录会自动生成为选中的目录，也可以手动修改。 名称：可根据业务需要自定义命名，不能为空。命名规则：只支持中文、英文、下划线、数字和“.”，且以中英文开头，长度为3-64个字符。 正文：可手动输入文字，也可使用组件插入特定的内容，如：表格、超链接、图片；正文样式也可以使用组件进行调整；正文编辑支持全屏模式；在左侧编辑正文时，右侧会同步展示编辑内容，便于查看、修改样式等。 编辑完成后，单击右上角“保存”，左侧目录树同步刷新，界面会自动跳转到文档页面，展示名称、正文，上方标签页的名称也会更新为Markdown文件名称。 移动Markdown（可选）。 单击并拖拽Markdown到目标目录后释放即可，移动成功后，目录树会自动刷新，Markdown文件的目录也会同步改变。 Markdown文件只能在同一根目录下进行移动。 处于编辑页面的Markdown文件不能移动。 父主题： API设计

角色与操作权限说明 CodeArts API服务各用户角色类型及对应的操作权限说明如下： 表1 通用设置默认角色权限说明 服务资源 权限 权限说明 项目管理员 项目经理 产品经理 测试经理 运维经理 系统工程师 Committer 开发人员 测试人员 参与者 浏览者 角色 权限设置 设置角色权限 Y Y N Y N N N N N N N 成员设置 设置项目成员 Y Y N Y N N N N N N N 项目 编辑 编辑项目信息 Y Y N Y Y N N Y Y N Y 表2 API测试默认角色权限说明 服务资源 权限 权限说明 项目管理员 项目经理 产品经理 测试经理 运维经理 系统工程师 Committer 开发人员 测试人员 参与者 浏览者 用例 创建 创建用例 Y Y Y Y N Y Y Y Y N N 查看 查看用例 Y Y Y Y Y Y Y Y Y Y Y 修改 修改用例 Y Y Y Y N Y Y Y Y N N 删除 删除用例 Y Y Y Y N Y Y Y Y N N 执行 执行用例 Y Y Y Y N Y Y Y Y N N 停止 停止用例 Y Y Y Y N Y Y Y Y N N 导出到文件 导出用例到文件 Y Y Y Y Y Y Y Y Y Y Y 从文件导入 从文件导入用例 Y Y Y Y N Y Y Y Y N N 从版本导入 从版本导入用例 Y Y Y Y N Y Y Y Y N N 合并到基线 合并到基线 Y Y N Y N Y Y N N N N 规范检查 规范检查 Y Y Y Y N Y Y Y Y N N 测试套 创建 创建测试套 Y Y Y Y N Y Y Y Y N N 查看 查看测试套 Y Y Y Y Y Y Y Y Y Y Y 修改 修改测试套 Y Y Y Y N Y Y Y Y N N 删除 删除测试套 Y Y Y Y N Y Y Y Y N N 执行 执行测试套 Y Y Y Y N Y Y Y Y N N 停止 停止测试套 Y Y Y Y N Y Y Y Y N N 测试版本 创建 创建测试版本 Y Y N Y N Y Y N N N N 查看 查看测试版本 Y Y Y Y Y Y Y Y Y Y Y 修改 修改测试版本 Y Y N Y N Y Y N N N N 删除 删除测试版本 Y Y N Y N Y Y N N N N 接口测试-关键字 创建 创建关键字 Y Y Y Y N Y Y Y Y N N 查看 查看关键字 Y Y Y Y Y Y Y Y Y Y Y 编辑 编辑关键字 Y Y Y Y N Y Y Y Y N N 删除 删除关键字 Y Y Y Y N Y Y Y Y N N 全局变量 创建 创建全局变量 Y Y Y Y N Y Y Y Y N N 查看 查看全局变量 Y Y Y Y Y Y Y Y Y Y Y 编辑 编辑全局变量 Y Y Y Y N Y Y Y Y N N 删除 删除全局变量 Y Y Y Y N Y Y Y Y N N 规则 创建 创建规则 Y Y Y Y N Y Y Y Y N N 查看 查看规则 Y Y Y Y Y Y Y Y Y Y Y 修改 修改规则 Y Y Y Y N Y Y Y Y N N 删除 删除规则 Y Y Y Y N Y Y Y Y N N 表3 项目资源默认角色权限说明 服务资源 权限 权限说明 项目管理员 项目经理 产品经理 测试经理 运维经理 系统工程师 Committer 开发人员 测试人员 参与者 浏览者 注册APIG 创建 注册API Y Y N N Y N N N N N N 查看 查看注册API Y Y Y Y Y Y Y Y Y Y Y 编辑 重新注册API Y Y N N Y N N N N N N 删除 删除注册API Y Y N N Y N N N N N N 版本控制 创建 版本管理页面新增版本按钮权限 Y Y N N N N N N N N N 查看 查看版本管理页面权限 Y Y Y Y Y Y Y Y Y Y Y 编辑 版本管理页面编辑按钮权限 Y Y N N N N N N N N N 删除 版本管理页面删除按钮权限 Y Y N N N N N N N N N 定时导入API 创建 创建定时导入任务 Y Y N N N N N N N N N 查看 查看定时导入任务 Y Y Y Y Y Y Y Y Y Y Y 编辑 编辑定时导入任务 Y Y N N N N N N N N N 删除 删除定时导入任务 Y Y N N N N N N N N N 执行 执行定时导入任务 Y Y N N N N N N N N N 父主题： 管理项目成员与角色权限