华为云用户手册

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：100000 表3 请求Body参数 参数 是否必选 参数类型 描述 params 是 MindmapPageParam object 脑图分页查询参数 表4 MindmapPageParam 参数 是否必选 参数类型 描述 offset 否 Integer 页码偏移量 limit 否 Integer 每页记录数 name 否 String 脑图名称 id_collection 否 Array of strings 主键集合id folder_id_collection 否 Array of strings 目录id project_id 是 String 项目id folder_root_id 否 String 根目录id branch_uri 否 String 分支uri iterator_uri 否 String 计划uri is_master 否 Integer 是否基线 creator_name_collection 否 Array of strings 创建者名称集合 updater_name_collection 否 Array of strings 更新人名称集合

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 value Array of IntegerIdAndNameVo objects 测试类型信息 表4 IntegerIdAndNameVo 参数 参数类型 描述 id Integer 数据库存储数字 name String 页面显示值 状态码： 400 表5 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 401 表6 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 404 表7 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容 状态码： 500 表8 响应Body参数 参数 参数类型 描述 code String 业务失败的错误码 reason String 业务失败的提示内容

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

操作步骤 单击主菜单的“可视化”，默认进入“运营大屏”页面。 大屏详细说明可参见表1。 选择进入需要查看的大屏。 单击“导出”按钮可将大屏的数据导出至本地查看。 表1 可视化运营大屏 大屏名称 说明 资源总览 大屏展示了硬件资源和常用云资源的数量、云资源总览、物理资源使用率、云资源配额统计、云资源使用趋势、虚拟资源分配率、虚拟资源分配额统计和虚拟资源使用率等内容，帮助用户更加清晰直观的了解资源的使用情况。 单击大屏右上角下拉框选择时间范围，用于指定物理资源使用率、云资源使用趋势、虚拟资源使用率展示的时间范围。 计算节点资源明细大屏和存储节点资源明细大屏属于资源总览的下钻大屏，相关数据内容可参见资源总览的数据内容，各展示项说明见表 资源总览。 硬件资源 大屏展示了硬件资源数量、运行状态、告警状态等，帮助用户实时掌握资源的运行情况，及时调整资源的分配，提高资源使用率以及避免可能的风险。 各展示项说明见表 硬件资源。 硬件告警 大屏展示了硬件资源近一个月的告警总量、告警总体状态、硬件告警统计、近一个月告警增长趋势和未清除的告警列表，帮助用户了解告警的整体现状，提高告警运营质量。 各展示项说明见表 硬件告警总览。 云服务状态 大屏展示云服务总体状态及各区域所有云服务的告警状态大盘，帮助用户掌握云服务的整体状态，快速识别出处于高危、隐患等状态的云服务分布，提高运营效率。 各展示项说明见表 云服务状态。 说明： 云服务状态说明如下： 高危：已部署的云服务存在未处理的紧急告警，则状态为高危。 隐患：已部署的云服务没有未处理的紧急告警，但存在未处理的重要告警，则状态为隐患。 健康：已部署的云服务即没有未处理的紧急告警，也没有未处理的重要告警，则状态为健康。 未部署：云服务未部署。 租户维度资源大屏 大屏展示各个云资源数量总计，从租户维度统计租户云列表、云资源变化趋势，并展示租户维度资源使用列表，帮助用户从租户维度全面掌握资源的分配和使用情况。 各展示项说明见表 租户维度资源大屏。 审计日志 大屏按风险级别对操作动作进行统计，并详细展示了操作人员在具体时间点对服务器、存储、网络设备等资源进行的操作，以审计日志报告的形式展现，方便用户查看。可在大屏右上角选择需要统计的时间范围。 各展示项说明见表 审计日志。 HCSO云服务资源容量明细 大屏展示HCSO云服务中各服务资源类型统计，并将分别以物理和逻辑维度展示总量、分配量、可用量的资源使用趋势。自助按虚拟机规格查询资源池的分配量、使用量等并支持导出。 各展示项说明见表 HCSO云服务资源容量明细。 表2 资源总览 展示项 说明 硬件资源 统计硬件资源数量。 常用云资源 统计ECS统计发放的虚拟机个数，EVS发放的磁盘个数，及其他常用云服务统计管理区和租户区已发放的资源。 单击EVS右侧的“详情”链接，可查看租户区和管理区存储节点资源容量明细。 云资源总览 统计ECS统计发放的虚拟机个数，EVS发放的磁盘个数，及其他云服务统计管理区和租户区已发放的资源。 物理资源使用率 展示所选时间范围内每日CPU和内存的平均使用率。 单击物理资源使用率右侧的“详情”链接，可查看租户区和管理区计算节点资源容量明细。 云资源配额统计 统计云资源的分配量与总量（只统计租户区）。 云资源使用趋势 展示所选时间范围内每日云资源分配率的变化趋势（只统计租户区）。 虚拟资源分配率 统计虚拟资源（vCPU、内存、磁盘）的分配率（租户区和管理区均统计在内）。 虚拟资源分配额统计 统计虚拟资源（vCPU、内存、磁盘）的分配量与总量（租户区和管理区均统计在内）。 虚拟资源使用率 展示所选时间范围内每日虚拟资源（vCPU、内存、磁盘）的使用率（租户区和管理区均统计在内）。 计算节点资源明细大屏 展示ECS资源各维度（AZ、Cluster、资源类型）的资源容量明细，包括vCPU、内存、vGPU等指标（租户区和管理区均统计在内）。 存储节点资源明细大屏 展示EVS资源各维度（AZ、资源类型）的资源容量明细，包括普通IO、高IO、超高IO等磁盘类型（租户区和管理区均统计在内）。 表3 硬件资源 展示项 说明 服务器 展示服务器数量和服务器名称、告警状态、运行状态、管理IP等信息。 交换机 展示交换机数量和交换机名称、告警状态、运行状态、管理IP等信息。 路由器 展示路由器数量和路由器名称、告警状态、运行状态、管理IP等信息。 防火墙 展示防火墙数量和防火墙名称、告警状态、运行状态、管理IP等信息。 安全设备 展示安全设备数量和安全设备名称、告警状态、运行状态、管理IP等信息。 表4 租户维度资源大屏 展示项 说明 租户云资源TOP10 按租户维度统计各个云资源的资源数，以资源数TOP10排序。 租户云资源使用趋势统计 按云资源维度统计每天资源数量变化趋势。 清单详情 各个云资源数量统计。 详情列表 云资源的详情列表，展示资源的常见信息。 表5 硬件告警总览 展示项 说明 告警总量 统计近一个月的历史告警（即已清除告警）和活动告警（即未清除告警），及各个级别的告警数量（包括已清除告警和未清除告警）。 告警总体状态 统计近一个月已清除告警的数量及占告警总数的比例，未清除告警的数量及占告警总数的比例。 硬件告警统计 分别统计近一个月网络设备（包含交换机、路由器、防火墙等）和物理主机的告警数量（包括已清除告警和未清除告警）。 近一个月告警增长趋势 统计近一个月各级别告警数量（包括已清除告警和未清除告警）的趋势。 当前告警 展示近一个月未清除告警的告警名称、级别、设备ID、开始发生时间、最后一次发生时间等信息。单击告警名称可查看告警详细信息。 历史告警 展示近一个月的历史告警（即已清除告警）和活动告警（即未清除告警）的告警名称、级别、设备ID、开始发生时间、最后一次发生时间等信息。单击告警名称可查看告警详细信息。 表6 审计日志 展示项 说明 风险级别统计 根据风险级别（紧急、重要、次要、提示）对操作动作进行汇总统计。 操作日志列表 轮播展示操作日志列表，显示操作名称、风险级别、操作人等信息。支持通过日志列表的操作名称、region匹配关键字搜索。 表7 云服务状态 展示项 说明 状态分布 统计处于高危、隐患、健康、未部署状态的云服务数量。 告警状态大盘 展示各区域内各云服务的状态及告警数量。 区域数量少于5个时，横向显示所有区域，区域下方一个方格代表该区域的一个云服务，已部署的云服务方格内显示当前未处理的紧急和重要告警数量。 区域数量是5个或5个以上时，告警状态大盘显示成一个二维表格，表头横向是各区域，纵向是各云服务。已部署的云服务，鼠标悬停到单元格上时显示对应区域对应云服务当前未处理的紧急和重要告警数量。 表8 HCSO云服务资源容量明细 展示项 说明 资源类型统计列表 展示常用基础云服务的容量视图情况。包含以下云服务：OBS、BMS、SFS、RDS、DeH、EIP、VPN。 资源使用趋势 展示不同云服务下的资源变化趋势。可在右上方选择时间维度，支持以“最近一周”、“最近一月”、“最近三月”进行查询。

操作步骤 单击界面右上方用户名，选择“消息通知设置”。 若未授权，请阅读页面提示信息确认授权后进行使用。授权相关内容请参见委托授权说明。 单击“创建规则”，请参考表 规则参数填写相关信息。 表1 规则参数 参数 说明 通知名称 新建告警通知的名称。 Region 选择对应的局点，支持多选。 消息类型 选择告警消息的类型，支持多选。 消息模板 选择告警消息的消息模板。 告警级别 告警通知的级别，可以设置为紧急、重要、次要或提示。 主题 选择消息通知的特定事件类型，详情请参见SMN主题管理。 描述 其他描述。 单击“确定”，完成创建。

示例流程 图1 给用户授权ESM服务权限流程 创建用户组并授权 在IAM控制台创建用户组，并授予ESM服务的权限“ESM FullAccess”。 创建用户并加入用户组 在IAM控制台创建用户，并将其加入1中创建的用户组。 用户登录并验证权限 新创建的用户登录控制台，验证ESM服务的权限： 在主菜单中选择 “组织”，进入“租户管理”页面。单击“创建租户”，若能正常创建租户，表示“ESM FullAccess”已生效。

前提条件 给用户组授权之前，请您了解用户组可以添加的系统权限，如表1所示。并结合实际需求进行选择。 表1 ESM系统策略 策略名称 描述 策略类型 策略使用建议 ESM FullAccess 拥有ESM管理权限，可以使用ESM所有功能。 系统策略 建议对进行开销户的管理员用户分配该策略。 ESM ReadOnlyAccess 拥有ESM只读权限，不可进行修改操作。 系统策略 建议对使用大屏可视的管理员用户分配该策略。

操作步骤 单击主菜单的“组织”。默认进入“租户管理”页面。 可执行表中表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 创建HCSO租户 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 其他任务 任务 说明 步骤 查看通知规则与消息模板 查看通知规则与消息模板的列表详情信息。 选择“通知规则”或“消息模板”菜单。 查看列表详情。 编辑通知规则与消息模板 当需要对通知规则与消息模板修改时，执行此任务。 说明： 默认模板不支持修改。 选择“通知规则”或“消息模板”菜单。 选择操作对象的所在行，单击“编辑”。 修改参数。 单击“确定”。 删除通知规则与消息模板 当通知规则与消息模板不再使用时，执行此任务进行删除。 说明： 默认模板不支持删除。 选择“通知规则”或“消息模板”菜单。 选择操作对象的所在行，单击“删除”。 单击“确定”。

授权 单击界面右上方用户名，选择“消息通知设置”。 在授权提示页面，阅读并确认授权信息。 使用消息通知服务（SMN）服务发送通知时，会根据实际用量进行费用收取。确认授权前请您务必了解SMN计费说明。 “确认授权”即ESM将会代理使用用户身份进行消息通知服务（SMN）服务调用，通过统一身份认证服务（IAM）创建委托授权进行资源运维。详情请参见委托其他账号管理资源。在创建委托前，请确保已有统一身份认证服务（IAM）的“创建委托”权限。详细授权操作请参见创建用户组并授权。 请勾选“我已理解并认可上述说明”，单击“确认授权”。 授权成功后默认进入“消息通知设置”页面。

授权项说明 ESM当前所支持的系统策略操作与API相对应，授权项内容请参见表2。授权项列表说明如下： 权限：允许或拒绝对指定资源在特定条件下进行某项操作。 授权项：系统策略中支持的Action。 表2 授权项说明 所属策略 权限 授权项（Action） ESM FullAccess HCSO局点管理 esm:hcso:get esm:hcso:list esm:hcso:update HCSO租户管理 esm:hcsoTenant:create esm:hcsoTenant:delete esm:hcsoTenant:get esm:hcsoTenant:list esm:hcsoTenant:update esm:hcsoTenantOwnerUser:create esm:hcsoTenantOwnerUser:update HCSO project查询 esm:hcsoProject:list 配额管理权限 esm:hcsoQuota:get esm:hcsoQuota:update 可视化查看 esm:hcsoDashboard:use 告警通知管理 esm:hcsoDashboard:create esm:hcsoDashboard:get esm:hcsoDashboard:delete esm:hcsoDashboard:update esm:hcsoDashboard:list ESM ReadOnlyAccess HCSO局点只读 esm:hcso:get esm:hcso:list HCSO租户只读 esm:hcsoTenant:get esm:hcsoTenant:list HCSO project查询 esm:hcsoProject:list 配额只读 esm:hcsoQuota:get 可视化查看 esm:hcsoDashboard:use 告警通知只读 esm:hcsoDashboard:get esm:hcsoDashboard:list

ESM权限 默认情况下，新建的IAM用户没有任何权限，您需要将其加入用户组，并给用户组授予策略或角色，才能使得用户组中的用户获得对应的权限，这一过程称为授权。授权后，用户就可以基于被授予的权限对云服务进行操作。 权限根据授权精细程度分为角色和策略。 角色：IAM最初提供的一种根据用户的工作职能定义权限的粗粒度授权机制。该机制以服务为粒度，提供有限的服务相关角色用于授权。由于各服务之间存在业务依赖关系，因此给用户授予角色时，可能需要一并授予依赖的其他角色，才能正确完成业务。角色并不能满足用户对精细化授权的要求，无法完全达到企业对权限最小化的安全管控要求。 策略：IAM最新提供的一种细粒度授权的能力，可以精确到具体服务的操作、资源以及请求条件等。基于策略的授权是一种更加灵活的授权方式，能够满足企业对权限最小化的安全管控要求。多数细粒度策略以API接口为粒度进行权限拆分，ESM支持的API授权项请参见ESM策略及授权项说明。 如表1所示为ESM的所有系统策略。 表1 ESM系统权限 策略名称 描述 策略类型 策略使用建议 ESM FullAccess 拥有ESM管理权限，可以使用ESM所有功能。 系统策略 建议对进行开销户的管理员用户分配该策略。 ESM ReadOnlyAccess 拥有ESM只读权限，不可进行修改操作。 系统策略 建议对使用大屏可视的管理员用户分配该策略。

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

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

响应消息体（可选） 该部分可选。响应消息体通常以结构化格式（如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”已生效。

请求方法 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和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

请求消息体（可选） 该部分可选。请求消息体通常以结构化格式（如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 请求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在同一个区域也相同，所以简洁起见将这两部分省略。

数据采集 在使用APM服务过程中用户开启APM数据采集开关后，APM仅采集应用性能指标及调用链相关数据，不涉及个人隐私数据。所采集的数据仅用于应用的性能分析和故障诊断，不会用于其他商业目的。 数据类型 采集数据 传输方式 存储方式 数据用途 时限 性能指标数据 JVM相关数据、异常、数据库、SQL语句以及中间件调用相关的数据。 通过WSS方式传输 APM服务端按照租户隔离存储 指标查看页面展示 免费版7天，企业版30天，到期彻底删除。 调用链数据 调用链event数据，包含中间件调用的相关数据。 通过WSS方式传输 APM服务端按照租户隔离存储 调用链前台查询展示 免费版7天，企业版30天，到期彻底删除。 资源信息 服务类型、服务名称、创建时间、删除时间、所在节点地址和服务发布端口。 通过WSS方式传输 APM服务端按照租户隔离存储 资源库前台查询展示 免费版7天，企业版30天，到期彻底删除。 资源属性 系统类型、系统启动事件、CPU个数、服务执行用户名称、服务进程id、服务的PodID、CPU标志、系统版本、服务使用的Web框架、JVM版本、时区、系统名称、采集器版本以及LastMail的Url。 通过WSS方式传输 APM服务端按照租户隔离存储 资源库前台查询展示 免费版7天，企业版30天，到期彻底删除。 前端性能指标数据 页面加载性能、JS错误数、服务流量、API请求相关数据。 通过https方式传输 APM服务端按照租户隔离存储 指标查看页面展示 免费版7天，企业版30天，到期彻底删除。 Profiler 应用程序运行过程中CPU、内存和延时的使用情况。 通过websocket方式传输 APM服务端按照租户隔离存储 指标查看页面展示 7天，到期彻底删除。 表1 采集项限制说明 采集项名称 最大值 监控项默认最大行数 500行 SQL 默认长度限制 2000字符 SQL Result Body体默认采集数量限制 100个 SQL Result Body体默认采集内容大小限制 999字符 Redis Body体默认长度限制 100字符 Mongo 最大集群数 10个 Mongo command默认长度限制 2000字符 Hbase command默认长度限制 500字符 Es RestClient上限 10个 Cassandra CQL默认长度限制 2000字符 Cassandra Session上限 10个 Kafka Mbean采集ObjectName上限 100个 Kafka ClientId对应IP缓存上限 100个 RabbitMq连接地址上限 20个 RabbitMq 每个地址最大缓存连接数 100个 RabbitMq Consumer上限 500个 RabbitMq 每个Consumer最大缓存Channel数 100个 RabbitMq 每个Channel没有ACK的消息数 3000条 RabbitMq 缓存的手动ACK Consumer个数 20个 RocketMq PID上限 20个 RocketMq ClientId上限 20个 Jetcd Tag最大长度 500字符 HttpClient连接池上限 10条 连接池调用链默认上报时间阈值 1毫秒 Dubbo Invocation长度限制 500字符 Dubbo Attachment长度限制 500字符 URL Body体默认长度限制 9999字符 URL 采集应用code body长度限制 0字符 Java Method Body体长度限制 8192字符

JavaAgent更新说明 目前仅支持主流的jdk8和jdk17，jdk17环境请选用末尾带-jdk17的版本。 表1 JavaAgent更新列表 版本号 更新说明 2.4.9-profiler 1、Profiler时延度量线程采集算法优化。 2.4.8-profiler 1、Profiler支持性能优化推荐。 2.4.8 1、支持redisson支持3.17.x。 2、url接口调用支持分位数。 2.4.7-profiler 1.支持用户包数据采集。 2.4.7 1.支持sql字节数的配置。 2.支持springbean插件。 3.支持jedis2.9.3。 2.4.6-profiler 支持时延持续性能剖析。 2.4.5-profiler 支持CPU、内存持续性能剖析。 2.4.5-jdk17 新增支持httpclient5，仅支持同步场景。 2.4.5 指标采集队列增加老化机制。 2.4.4 新增支持SpringCloudGateway（2.1.x~3.1.x）。 2.4.3 1.修复异常数未清零问题。 2.修复日志过大问题。 3.新增redisson基本信息。 2.4.2-jdk17 该版本只支持jdk17。 2.4.2 支持FunctionGraph在启动时关闭agent。 2.4.1 1.支持动态修改指标采集阈值。 2.接口调用维度新增异常数，统计url中日志标记的异常。 3.新增通过代理传输数据的功能。 2.3.19 1.支持日志自动打印traceId。 2.提高线程详情上限。 2.3.17 1.AKSK可以从环境变量读取。 2.调用链增加sqlId。 3.sql增加最近调用链。 4.补齐接口调用的集群维度分析能力。 2.3.16 1.指定注册协议。 2.兼容ibm sdk不支持线程内存获取。 2.3.15 1.新增支持dubbo2.8.x版本。 2.新增支持JDKhttp子类。 2.3.13 1.CSE Provider bizcode支持多key。 2.支持hikari插件。 2.3.12 1.客户端统计时，hashmap的key数量溢出后，之前是停止采集，现在修改为继续采集。 2.Url支持自动规整能力，当在后台配置为自动规整后，url按照原始格式规整。 3.oracle插件补齐读取行数和更新行数能力。 4.CSE Provider提供显示bizCode的功能。 5.修复CSE Provider修复状态码400时调用链没有标红。 2.3.5 1.支持启动脚本配置access地址。 2.3.2 1.支持jetty-client。 2.取消对com.huawei.bsp.commonlib.roa.restclient的支持。 3.url支持采集apdex。 2.3.1 1.支持cce解密sk。 2.支持jedis拦截key和value。 3.支持cassandra3。 2.2.15 1.支持sk自定义解密。 2.支持在启动脚本中配置master地址。 3.支持apacheHttpclient的responseBody采集。 2.2.13 1.使NamedTransformer加载接口类时直接返回原字节码。 2.解决mariadb3.0.4 sql没有采集到的问题。 3.支持oracle。 2.2.10 1.支持gauss-zenith数据库。 2.支持com.huawei.bsp.commonlib.roa.restclient。 2.2.9 1.支持jetcd 5.x - 6.x。 2.支持采集netty直接内存。 表2 CCE和Servicestage界面上 JavaAgent latest版本指向说明 版本号 实际版本号 latest-x86_64 2.4.3，支持x86架构。 latest-aarch64 2.4.3，支持arm架构。 latest-noroot-x86_64 2.4.3，支持x86架构，支持非root用户身份运行容器。 latest-noroot-aarch64 2.4.3，支持arm架构，支持非root用户身份运行容器。 latest 2.1.7，兼容x86和arm架构。

URL跟踪 在某些场景下，用户需要关注某个重要应用调用的拓扑关系，称之为URL跟踪分析，比如电子商务系统的创建订单的接口调用。在APM系统，由于URL跟踪消耗资源较大，并不会默认将入口的url调用标示为URL跟踪，需要用户自己将某个环境的某个监控项的调用标示为URL跟踪。APM对于总体URL跟踪标示个数有限制，对于标示为URL跟踪的接口，APM会重点跟踪由此引起的下游的一系列调用关系。通过URL跟踪可以让用户跟踪某一些重要接口调用与下游的服务调用关系，从更细粒度角度发现问题。

系统管理 系统管理包括三部分：访问密钥、通用配置以及探针统计。 访问密钥：访问密钥（AK/SK，Access Key ID/Secret Access Key）包含访问密钥ID（AK）和秘密访问密钥（SK）两部分，是您在华为云APM服务的长期身份凭证，JavaAgent携带密钥ID（AK）上报数据，华为云通过该AK识别访问用户的身份，通过SK对请求数据进行签名认证，用于确保上报请求的机密性、完整性和请求者身份的正确性。 通用配置：设置Agent字节码方式拦截，慢请求阈值、监控指标数据采集的最大行数以及前端监控聚合设置。 探针统计：APM支持对租户使用的探针数量进行统计，您可以从多个维度（时间、区域、探针类型）查看租户使用的探针数量。

应用拓扑 应用拓扑主要分两种： 单组件拓扑：是单个组件下的单个环境的拓扑，同时可以展开直接或间接上下游的组件的拓扑关系。 全局应用拓扑：可以查看这个应用下面全部或者部分组件的全局拓扑关系。 拓扑图展示服务之间一段时间的调用关系，可以是从调用方统计的，也可以是从被调用方统计的，并且可以查看这个调用关系的趋势图。通过拓扑图，一方面可以自动梳理服务之间的调用关系，同时也可以从全局视角查看服务之间调用是否正常，快速定位问题所在。可以清晰地展示应用间关系、调用数据（服务、实例指标）、健康状况等详细内容。

查看URL监控 接口维度汇总 针对外部服务调用常见的URL调用，系统会采集每个URL的指标。具体指标以及说明，参见表1。 图4 接口维度汇总URL监控 表1 接口维度汇总指标说明表 指标集 指标 说明 接口维度汇总 url 请求的url。 method 请求的httpmethod。 调用次数 该url的调用次数。 平均响应时间(ms) 该url在采集周期内平均响应时间。 错误数 该url的错误数。 最大并发 该url的最大并发。 最慢调用(ms) 该url在采集周期内最大响应时间。 apdex 满意度，取值范围0~1。数值越趋近于1，表示满意度越高。 详情请参见基本概念-apdex。 异常数 该url的异常数。 0-10ms 响应时间在0-10ms范围请求数。 10-100ms 响应时间在10-100ms范围请求数。 100-500ms 响应时间在100-500ms范围请求数。 500-1000ms 响应时间在500-1000ms范围请求数。 1-10s 响应时间在1-10s范围请求数。 10s-n 响应时间在10s以上请求数。 接口调用会作为调用链的起点，单击某个URL，系统会跳转到调用链页面，显示默认20分钟内该接口的调用情况。 可以将某个环境的某个监控项的调用标示为URL跟踪，具体配置方法请参见配置URL跟踪。 单击“调用次数”、“平均响应时间”等列的蓝色字体数值，会以图表的形式显示对应的数值详情。 状态码维度汇总 APM支持以状态码的维度汇总对接口的调用次数。系统会采集每个URL的指标。具体指标以及说明，参见表2。 图5 状态码维度汇总URL监控 表2 状态码维度汇总指标说明表 指标集 指标 说明 状态码维度汇总 code 状态码。 个数 该状态码的发生次数。 最近url 该状态码在采集周内采样的url。 单击“code”列的某个状态码，系统会跳转到调用链页面，显示默认20分钟内所在环境，所选实例该状态码的调用情况。 单击“个数”列的数值，可以查看所选时间段内该状态码的趋势图。 单击最近url，可以查看对应状态码下的调用详情。 集群维度汇总 APM支持以集群的维度汇总对接口的指标。具体指标以及说明，参见表3。 图6 集群维度汇总URL监控 表3 集群维度汇总指标说明表 指标集 参数 说明 集群维度汇总 clusterId 调用方的集群id。 调用次数 该集群的调用次数。 平均响应时间(ms) 用户在采集周期内平均响应时间。 错误数 该集群调用的错误次数。 最大并发 该集群的最大并发次数。 最慢调用(ms) 用户在采集周期内最慢调用时间。 单击“调用次数”、“平均响应时间”等列的蓝色字体数值，会以图表的形式显示对应的数值详情。 总览 可以在总览页签下查看所选实例的指标的趋势图。具体指标以及说明，参见表4。选中某一个时间节点时，图表支持联动。展示该时间节点下，总请求数、平均响应时间(ms)、错误次数以及apdex的实际数值。 图7 URL监控总览 表4 总览指标说明表 指标集 指标 说明 总览 总请求数 url的总请求数。 平均响应时间(ms) url的平均响应时间。 错误次数 url的总错误次数。 apdex url的满意度。