华为云用户手册

涉及接口 用户TestHub服务操作包括，注册新服务、获取已注册服务、更新已注册服务、删除已注册服务，其中获取、更新、删除操作需要注册过后方可进行，涉及接口如下： 新测试类型服务注册：未注册过服务的全新用户使用，将自己的服务名和服务 域名 注册。 用户获取自己当前已经注册的服务：已注册过服务的用户可以查询到自己服务的服务ID和服务名称。 更新已注册服务：已注册过服务的用户可以修改自己的服务名和服务域名。 删除已注册服务：已注册过服务的用户可以传入自己的服务ID删除掉自己已注册的服务。

响应消息体 响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。 对于获取用户Token接口，返回如下消息体。为篇幅起见，这里只展示部分内容。 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "xx-xxxxxx-1", ...... 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error_msg": "The format of message is error", "error_code": "AS.0001" } 其中，error_code表示错误码，error_msg表示错误描述信息。

终端节点 终端节点（Endpoint）即调用API的请求地址，不同服务不同区域的终端节点不同，您可以从地区和终端节点中查询所有服务的终端节点。 测试计划的终端节点如下表所示，请您根据业务需要选择对应区域的终端节点。 区域名称 区域 终端节点 华北-北京四 cn-north-4 cloudtest-ext.cn-north-4.myhuaweicloud.com 华北-北京一 cn-north-1 cloudtest-ext.cn-north-1.myhuaweicloud.com 华东-上海二 cn-east-2 cloudtest-ext.cn-east-2.myhuaweicloud.com 华东-上海一 cn-east-3 cloudtest-ext.cn-east-3.myhuaweicloud.com 华南-广州 cn-south-1 cloudtest-ext.cn-south-1.myhuaweicloud.com 父主题： 使用前必读

操作步骤 确定调用API鉴权时使用的Token。 查询token，详情请参见获取用户Token。 获取响应Header参数中X-Subject-Token对应的值。 创建测试计划。 接口相关信息 URL格式：POST /v1/projects/{project_id}/plans 接口请求参数说明详情，请参见“项目下创建计划”接口。 请求示例 POST https://{endpoint}/v1/projects/{project_id}/plans {endpoint}信息请从终端节点获取。 {project_id}为项目唯一标识。 Body： { "name" : "这是一个测试计划名称", "assigned_id" : "efdb403066474ab08836b9eeaaa23bca", "service_id_list" : [ 0 ], "plan_cycle" : { "start_date" : "2020-03-04", "end_date" : "2020-03-31" } } 响应示例 { "plan_id" : "efdb403066474ab08836b9eeaaa23bca", "error_code" : "CLOUDTEST.000XXXXXX", "error_msg" : "失败原因XXXXX" } 向测试计划中添加用例。 接口相关信息 URL格式：POST /v1/projects/{project_id}/plans/{plan_id}/testcases/batch-add 接口请求参数说明详情，请参见“计划中批量添加测试用例”接口。 请求示例 POST https://{endpoint}/v1/projects/{project_id}/plans/{plan_id}/testcases/batch-add {endpoint}信息请从终端节点获取。 {project_id}为项目唯一标识。 Body： { "service_id" : 13, "testcase_id_list" : [ "efdb403066474ab08836b9eeaaa23bca", "251fca07b22f493692eb06b1754f07a8" ] } 响应示例 { "error_code" : "CLOUDTEST.000XXXXXX", "error_msg" : "失败原因XXXXX", "error_detail" : { "failed" : [ { "error_code" : "CLOUDTEST.000XXXXXX", "error_msg" : "失败原因XXXXX", "testcase_id" : "efdb403066474ab08836b9eeaaa23bca" } , { "error_code" : "CLOUDTEST.000XXXXXX", "error_msg" : "失败原因XXXXX", "testcase_id" : "251fca07b22f493692eb06b1754f07a8" }] } }

调用API获取项目ID 项目ID还用通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”，其中{Endpoint}为 IAM 的终端节点，可以从终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下，其中“projects”下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "xxxxxxxx", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }

基本概念 账号 用户注册云平台时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用它们进行日常管理工作。 用户 由账号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域（Region） 从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。 Region分为通用Region和专属Region： 通用Region指面向公共租户提供通用云服务的Region。 专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 详情请参见区域和可用区。 可用区（AZ，Availability Zone） 一个AZ是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 用户在项目管理中创建的项目，根据模板创建项目，根据您选择的项目模板，还包含有预置的工作项、代码或资源等。通过管理项目IAM用户（即“团队成员”）所需的权限。将IAM用户作为团队成员添加到项目，给每个团队成员分配角色并赋予项目及其资源的操作权限。 企业项目 企业项目是项目的升级版，针对企业不同项目间资源的分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。 父主题： 使用前必读

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "id": "xxxxxxxx" } } } } 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如，Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 GET https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证：https://bbs.huaweicloud.com/videos/101333。

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签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

概述 测试计划（CodeArts TestPlan）是面向软件开发者提供的一站式云端测试平台，覆盖测试管理、接口测试，融入DevOps敏捷测试理念，帮助您高效管理测试活动，保障产品高质量交付。您可以使用本文档提供的API对测试计划进行相关操作，如创建、删除测试用例等。支持的全部操作请参见API概览。 在调用测试计划的API之前，请确保已经充分了解测试计划的相关概念，详细信息请参见产品介绍。 父主题： 使用前必读

操作步骤 单击主菜单的“组织”。默认进入“租户管理”页面。 可执行表中表1的操作。 表1 相关操作 任务 说明 步骤 查看租户列表 当需要查看租户名称、状态及描述时，可以直接在列表中查看。 查看租户内的各项基础信息。 导出租户 将租户的基本信息导出并保存到本地，仅用于信息备份和统计。 单击“导出 ＞ 导出租户”，默认导出所有租户。 导出项目 将租户下所有的项目信息进行导出。 单击“导出 ＞ 导出项目”，默认导出所有项目。

操作步骤 单击界面右上方用户名，选择“ 消息通知 设置”。 选择“消息模板”菜单，单击“创建模板”。 请参考表 模板参数创建进行。 表1 模板参数 参数 说明 模板名称 新建模板的名称。 描述 其他描述。 邮件或短信 主题 邮件主题内容，该参数仅当选择邮件方式时存在。 正文 支持以邮件或短信进行告警消息通知。 说明： 消息通知模板中支持的变量及取值范围如下所示： 告警名称：${alarm_name} 告警id：${alarm_id} 告警Region：${region_code} 告警类别：${event_category}，取值：硬件告警（HARDWARE）/云服务告警（SERVICE_ALARM） 告警级别：${event_severity}，取值：Critical/Major/Minor/Warning 告警对象：${event_object} 清除类型：${clear_category}，取值：发生（Occur）/清理（Clear） 时间：${time}，取值：告警发生时间/告警清理时间（UTC时间） 单击“确定”，完成创建。

支持审计的关键操作列表 表1 支持审计的关键操作列表 操作名称 事件名称 更新局点信息 updateHcso 创建租户账号 createHcsoTenantAccount 修改租户账号 updateHcsoTenantAccount 删除租户账号 deleteHcsoTenantAccount 冻结租户账号 suspendHcsoTenantAccount 取消冻结租户账号 unsuspendHcsoTenantAccount 设置租户配额 updateHcsoTenantQuota 还原预注销租户 restoreHcsoDomain 创建H CS O租户 createHcsoDomain 修改HCSO租户 updateHcsoDomain 删除HCSO租户 deleteHcsoDomain 冻结/解除冻结租户 suspendHcsoDomain 预注销租户 deregisterHcsoDomain 创建HCSO租户用户 createOwnerUser 重置密码 updateOwnerUser 修改冷冻期时间 updateHcsoFreezingPeriod 创建HCSO局点 esm:CreateCustomerInfo 修改HCSO局点 updateHcso 删除HCSO esm:DeleteCustomerInfo 回退HCSO esm:RollbackCustomerInfo 修改hcso对接账号 updateHcsoAccount 导出HCSO局点ROS对接服务列表 esm:ListRosService 将HCSO局点服务添加到ROS对接例外 exceptHcsoRosService 新增配额配置 esm:CreateQuotaMetaInfo 删除配额配置 esm:DeleteQuotaMetaInfo 回退配额配置 esm:RollbackQuotaMetaInfo 导出租户列表 exportHcsoDomain 导出项目列表 exportHcsoProject 更新基线ros对接配置信息 updateRosConfiguration 更新基线ros对接云服务列表 updateRosServices 添加或取消添加ros对接云服务例外 exceptRosService 导入基线ros对接云服务列表 importRosServices 导出基线ros对接云服务列表 exportRosServices 开通ESM服务 openService 删除租户任务 createCleanupDomainJob 添加话单配置 createMeterApp 修改话单配置 updateMeterApp 删除话单配置 deleteMeterApp 重试任务 retrySdr 创建查询任务 createQueryJob 局点版本接入 createHcsoEdition 修改局点版本信息 UpdateHcsoEdition 虚拟局点接入 createVirtualHcso 修改虚拟局点详情 UpdateVirtualHcso 删除虚拟局点详情 DeleteVirtualHcso 回退虚拟局点 RollebackVirtualHcso 导出大屏数据 DlvDataExport

操作步骤 单击界面右上方用户名，选择“消息通知设置”。 执行表 其他任务中的操作。 表1 其他任务 任务 说明 步骤 查看通知规则与消息模板 查看通知规则与消息模板的列表详情信息。 选择“通知规则”或“消息模板”菜单。 查看列表详情。 编辑通知规则与消息模板 当需要对通知规则与消息模板修改时，执行此任务。 说明： 默认模板不支持修改。 选择“通知规则”或“消息模板”菜单。 选择操作对象的所在行，单击“编辑”。 修改参数。 单击“确定”。 删除通知规则与消息模板 当通知规则与消息模板不再使用时，执行此任务进行删除。 说明： 默认模板不支持删除。 选择“通知规则”或“消息模板”菜单。 选择操作对象的所在行，单击“删除”。 单击“确定”。

预注销管理 为了防止租户账号被误删或需要恢复，系统默认开启预注销管理功能。 预注销租户 单击主菜单的“组织”。默认进入“租户管理”页面。 单击“更多 ＞ 预注销”。 确认弹框提示信息，单击“确定”。 租户状态将变为“预注销”，默认进入“预注销管理”页面。 预注销管理 单击主菜单的“组织”。默认进入“租户管理”页面。 单击“预注销管理”页签。 根据表 预注销管理操作执行以下操作。 表3 预注销管理操作 任务 说明 步骤 开启或关闭设置冷冻期 根据需要设置是否开启冷冻期。 单击开启设置冷冻期。 单击关闭设置冷冻期。 设置冷冻期时长 该设置对全局生效，但对已进入冷冻期的预注销租户不生效。 单击打开“设置冷冻期”。 设置销户冷冻期时间。 单击“确定”。 还原租户 根据需要对预注销的租户进行还原操作。 说明： 只有状态为“已冻结”的租户支持还原操作。 在租户所在行，单击“操作 ＞ 还原”。 也可选中需要还原的租户，单击左上方“还原”进行批量操作。 删除租户 对不需要使用的租户进行彻底删除操作。 说明： 租户冷冻期已解除的租户才可执行删除操作。 彻底删除后，租户下的所有资源数据及配置都无法恢复，请谨慎操作。 在租户所在行，单击“彻底删除”。 在弹框中输入“租户名+DELETE”后，单击“确定”。

查看与修改 单击主菜单的“组织”。默认进入“租户管理”页面。 可执行表中表2的操作。 表2 相关操作 任务 说明 步骤 查看租户列表 当需要查看租户名称、状态及描述时，可以直接在列表中查看。 查看租户内的各项基础信息。 导出租户 将租户的基本信息导出并保存到本地，仅用于信息备份和统计。 单击“导出 ＞ 导出租户”，默认导出所有租户。 导出项目 将租户下所有的项目信息进行导出。 单击“导出 ＞ 导出项目”，默认导出所有项目。 单击“操作 ＞ 修改”。 修改租户描述。 当进行白名单配置时，也可修改租户名称。 单击“确认”。

响应消息体（可选） 该部分可选。响应消息体通常以结构化格式（如JSON或XML）返回，与响应消息头中Content-Type对应，传递除响应消息头之外的内容。 对于创建查询任务接口，返回如下消息体。 { "job_id": "********" } 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error_msg": "The format of message is error", "error_code": "AS.0001" } 其中，error_code表示错误码，error_msg表示错误描述信息。

创建用户并授权IAM ESM FullAccess策略 登录 统一身份认证 服务（IAM）控制台。 在IAM控制台创建用户组，并授予ESM服务的权限“ESM FullAccess”。 在IAM控制台创建用户，并将其加入2中创建的用户组。 用户登录并验证权限。 新创建的用户登录控制台，验证ESM服务的权限：在主菜单中选择 “组织”，进入“租户管理”页面。单击“创建租户”，若能正常创建租户，表示“ESM FullAccess”已生效。

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。 Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。Token可通过调用获取用户Token接口获取。 云服务存在两种部署方式：项目级服务和全局级服务。其中： 项目级服务需要获取项目级别的Token，此时请求body中“auth.scope”的取值为“project”。 全局级服务需要获取全局级别的Token，此时请求body中“auth.scope”的取值为“domain”。 调用本服务API需要项目级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 获取Token后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 POST https://esm-api.cn-south-1.myhuaweicloud.com/meter/v1/{domain_id}/query-jobs Content-Type: application/json X-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证：https://bbs.huaweicloud.com/videos/101333。

创建用户并授权IAM ESM ReadOnlyAccess策略 登录统一身份认证服务（IAM）控制台。 在IAM控制台创建用户组，并授予ESM服务的权限“ESM ReadOnlyAccess”。 在IAM控制台创建用户，并将其加入2中创建的用户组。 将新创建的用户ID反馈至华为云服务技术支持人员，由技术支持人员进行大屏配置。 用户登录并验证权限。 新创建的用户登录控制台，验证ESM服务的权限：在主菜单中选择 “可视化”，若能正常查看大屏，表示“ESM ReadOnlyAccess”已生效。

请求消息体（可选） 该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于创建查询任务接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，字段需要根据实际值填写。 POST https://esm-api.cn-south-1.myhuaweicloud.com/meter/v1/{domain_id}/query-jobs Content-Type: application/json { "hcso_id": "********", "region_id": "********", "min_sdr_time": "2022-01-01 00:00:00", "max_sdr_time": "2022-02-01 00:00:00" } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 是否必选 示例 Content-Type 消息体的类型（格式）。推荐用户使用默认值application/json，有其他取值时会在具体接口中专门说明。 是 application/json Accept 接收消息体的类型（格式），当前只支持application/json。 否 application/json X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头（Headers）中包含的“X-Subject-Token”的值即为Token值。 是 使用Token认证时该字段必选。 注：以下仅为Token示例片段 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务您正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 在创建查询任务的URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://esm-api.cn-south-1.myhuaweicloud.com/meter/v1/{domain_id}/query-jobs

请求URI 请求URI由如下部分组成： {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同。 例如ESM服务在“华南-广州”区域的Endpoint为“esm-api.cn-south-1.myhuaweicloud.com”。 resource-path 资源路径，即API访问路径。从具体API的URI模块获取，例如“创建查询任务”API的resource-path为“/meter/v1/{domain_id}/query-jobs”。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“?”，形式为“参数名=参数取值”，例如“?limit=10”，表示查询不超过10条数据。 例如您需要获取ESM在“华南-广州”区域的Token，则需使用“华南-广州”区域的Endpoint（esm-api.cn-south-1.myhuaweicloud.com），并在创建查询任务的URI部分找到resource-path（/meter/v1/{domain_id}/query-jobs），拼接起来如下所示。 https://esm-api.cn-south-1.myhuaweicloud.com/meter/v1/{domain_id}/query-jobs 图1 URI示意图 为方便查看，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

Agent启停 当Agent处于启动状态时，启停按钮显示为；当Agent处于停止状态时，启停按钮显示为。 停止Agent 在实例列表页面，单击需要停用Agent的实例所在行的启停按钮。 在弹出的“停用Agent”弹框单击“确定”，完成对所选实例的停止。 启动Agent 在实例列表页面，单击需要启动Agent的实例所在行的启停按钮。 在弹出的“启用Agent”弹框单击“确定”，完成对所选实例的启动。

注意事项 每个用户最多可创建2个访问密钥，每个访问密钥权限相同，相互独立，包括一对AK/SK，有效期为永久。为了账号安全性，建议您妥善保管并定期修改访问密钥，修改访问密钥的方法为删除旧访问密钥，然后重新生成。 由于apm.config文件默认对SK明文存储，不符合某些对于安全有更高要求的用户，apm提供了一种用户自定义的加解密方式，建议用户优先使用加解密方式。 加解密过程如下： 用户编写一个java类，比如com.demo.DecryptDemo，增加一个解密方法，比如decrypt输入和输出均字符串。 编写decrypt的方法内容，实现输入的SK解密，返回解密后的值。 将com.demo.DecryptDemo类打包成jar包，将这个jar包以及依赖的包放在javaagent的文件夹apm-javaagent/ext下。 用户修改apm.config配置文件，增加以下内容： decrypt.className=com.demo.DecryptDemo decrypt.methodName=decrypt secret.key={用户自加密的后的字符串}

场景说明 一个动态单词统计系统，数据源为持续生产随机文本的逻辑单元，业务处理流程如下： 数据源持续不断地发送随机文本给文本拆分逻辑，如“apple orange apple”。 单词拆分逻辑将数据源发送的每条文本按空格进行拆分，如“apple”，“orange”，“apple”，随后将每个单词逐一发给单词统计逻辑。 单词统计逻辑每收到一个单词就进行加一操作，并将实时结果打印输出，如： apple：1 orange：1 apple：2

操作步骤 进入工程本地根目录，在Windows命令提示符窗口中执行下面命令进行打包。 mvn -s "{maven_setting_path}" clean package 上述打包命令中的{maven_setting_path}为本地Maven的“settings.xml”文件路径。 打包成功之后，在工程根目录的target子目录下获取打好的jar包。 将导出的Jar包上传至Linux运行环境的任意目录下，例如“/optclient”。 将工程中的“lib”文件夹和“conf”文件夹上传至和Jar包相同的Linux运行环境目录下，例如“/opt/client”（其中“lib”目录汇总包含了工程中依赖的所有的Jar包，“conf”目录包含运行jar包所需的集群相关配置文件，请参考准备运行环境）。 运行此样例代码需要设置运行用户，设置运行用户有两种方式，添加环境变量HADOOP_USER_NAME或者修改代码设置运行用户。若在没有修改代码的场景下，执行以下语句添加环境变量： export HADOOP_USER_NAME=test 用户可向管理员咨询运行用户。test在这里只是举例，若需运行Colocation相关操作的样例代码，则此用户需属supergroup用户组。 执行如下命令运行Jar包。 java -cp HDFSTest-XXX.jar:conf/:lib/* com.huawei.bigdata.hdfs.examples.HdfsExample java -cp HDFSTest-XXX.jar:conf/:lib/* com.huawei.bigdata.hdfs.examples.ColocationExample 在运行com.huawei.bigdata.hdfs.examples.ColocationExample:时，HDFS的配置项“fs.defaultFS”不能配置为“viewfs://ClusterX”。

操作步骤 进入工程本地根目录，在Windows命令提示符窗口中执行下面命令进行打包。 mvn -s "{maven_setting_path}" clean package 上述打包命令中的{maven_setting_path}为本地Maven的“settings.xml”文件路径。 打包成功之后，在工程根目录的target子目录下获取打好的jar包。 将导出的Jar包上传至Linux运行环境的任意目录下，例如“/opt/client”。 将工程中的“lib”文件夹和“conf”文件夹上传至和Jar包相同的Linux运行环境目录下（其中“lib”目录汇总包含了工程中依赖的所有的Jar包，“conf”目录包含运行jar包所需的集群相关配置文件，请参考准备运行环境）。 执行如下命令运行Jar包。 java -cp HDFSTest-XXX.jar:conf/:lib/* com.huawei.bigdata.hdfs.examples.HdfsExample java -cp HDFSTest-XXX.jar:conf/:lib/* com.huawei.bigdata.hdfs.examples.ColocationExample 在运行“com.huawei.bigdata.hdfs.examples.ColocationExample”时，HDFS的配置项“fs.defaultFS”不能配置为“viewfs://ClusterX”。

场景说明 一个动态单词统计系统，数据源为持续生产随机文本的逻辑单元，业务处理流程如下： 数据源持续不断地发送随机文本给文本拆分逻辑，如“apple orange apple”。 单词拆分逻辑将数据源发送的每条文本按空格进行拆分，如“apple”，“orange”，“apple”，随后将每个单词逐一发给单词统计逻辑。 单词统计逻辑每收到一个单词就进行加一操作，并将实时结果打印输出，如： apple：1 orange：1 apple：2

吞吐量大场景下使用MiniBatch聚合增加吞吐量 MiniBatch聚合的核心思想是将一组输入的数据缓存在聚合算子内部的缓冲区中。当输入的数据被触发处理时，每个key只需一个操作即可访问状态，可以很大程度减少状态开销并获得更好的吞吐量。但是可能会增加一些延迟，因为它会缓冲一些记录而不是立即处理，这是吞吐量和延迟之间的权衡。默认未开启该功能。 API方式： // instantiate table environmentTableEnvironment tEnv = ... // access flink configuration Configuration configuration = tEnv.getConfig().getConfiguration(); // set low-level key-value options configuration.setString("table.exec.mini-batch.enabled", "true"); // enable mini-batch optimizationconfiguration.setString("table.exec.mini-batch.allow-latency", "5 s"); // use 5 seconds to buffer input recordsconfiguration.setString("table.exec.mini-batch.size", "5000"); // the maximum number of records can be buffered by each aggregate operator task 资源文件方式（flink-conf.yaml）： table.exec.mini-batch.enabled: true table.exec.mini-batch.allow-latency : 5 s table.exec.mini-batch.size: 5000