ARMS企业级场景被集成场景介绍

电玩女神 2022-08-30 05:18 96阅读 0赞

**简介：** ARMS企业级场景被集成场景介绍

![56f5ded39bcc4efc94ff1398a9db9782.png][]

通过本次最佳实践内容，您可以看到ARMS OpenAPI可以灵活的被集成到客户链路监控场景，并对其进行可视化图形展示监控信息。

## 1. 背景信息 ##

应用实时监控服务ARMS（Application Real-Time Monitoring Service）是一款应用性能管理产品，能帮助你实现全栈式的性能监控和端到端的全链路追踪诊断，让应用运维更加高效。

本次最佳实践是基于调用ARMS OpenAPI的形式来实现客户应用场景链路监控的可视化图形展示，使用环境为专有云V3.10版本ASCM控制台，调用ARMS OpenAPI接口通过工具Postman进行测试，在第二章节详细介绍了测试环境及测试工具。第三章节通过一个查询所有应用ARMS OpenAPI接口描述调用过程，并且包含该接口需要请求传入的参数接口列表。最后一章节将对一个复杂应用场景，获取链路监控信息使用到ARMSOpenAPI接口，对每个接口列表字段、调用过程及返回结果详细介绍。

最佳实践价值

通过调用ARMS OpenAPI在应用场景的使用，直观给阅读者了解到ARMS产品的能力，及ARMS提供一套OpenAPI可以容易的集成到客户应用中，快速实现复杂的微服务链路监控能力，由ARMS监控服务能力涵盖范围能力比较广，包含浏览器、小程序、APP、分布式应用和容器环境，因此完整的监控能力，开发过程中不需要集成多开源组件的形式，使微服务程序监控功能开发简单，让应用运维变得容易。

## 2. 环境 ##

在使用ARMS前您需要按照以下内容对当前的系统环境进行检查。

本次最佳实践基于专有云企业版V3.10.0版本ARMS。

**说明**：ARMS OpenAPI各个版本变化不大，使用方式保持一致，所以此文档也适用于公共云产品或专有云V3.7.0以上版本。专有云V3.10.0控制台称为ASCM，V3.10.0之前版本为Apsara Stack。

1.登录ASCM控制台。

2.将鼠标指向页面上方导航栏中的**产品**，单击**企业级分布式应用服务EDAS**。

![1.jpg][]

图1：ASCM

**说明**：由于ARMS监控应用数据，需要EDAS产品配合。本次测试先通过EDAS部署一个标准的Spring Boot应用，开通ARMS监控并得到监控数据。

![2.jpg][]

图 2：EDAS控制台

![3.jpg][]

图 3：ARMS控制台

3.测试工具检查。

本实践将会在专有云环境中创建win64虚拟机，然后在虚拟机中安装Postman进行测试。

![4.jpg][]

图4：Postman测试

## 3. Open API使用 ##

调用URL确认

OpenAPI接口均为REST服务，首先确认服务的URL。  
每个专有云环境域名不同，会导致URL不同。请根据具体环境信息修改URL信息，前缀及端口不变。  
`http://arms.console.example.com:8099/`

<table> 
 <thead> 
  <tr> 
   <td>名称</td> 
   <td>接口</td> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>数据集API</td> 
   <td>/dataset/GeneralQuery.json</td> 
  </tr> 
  <tr> 
   <td>关键应用性能指标</td> 
   <td>/metric/Metric.json</td> 
  </tr> 
  <tr> 
   <td>报警信息</td> 
   <td>无</td> 
  </tr> 
  <tr> 
   <td>应用监控-应用拓扑</td> 
   <td>/trace/Dependecies.json</td> 
  </tr> 
  <tr> 
   <td>事件集</td> 
   <td>/eventset/EventList.json</td> 
  </tr> 
 </tbody> 
</table>

调用示例-查看所有应用：

API说明

URL：`http://arms.console.example.com:8099/trace/Services.json`

参数列表

<table> 
 <thead> 
  <tr> 
   <td>字段名称</td> 
   <td>字段类型</td> 
   <td>字段含义</td> 
   <td>是否必选</td> 
   <td>备注</td> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>_userId</td> 
   <td>String</td> 
   <td>用户id</td> 
   <td>是</td> 
   <td>用户名称(如arms_admin)</td> 
  </tr> 
 </tbody> 
</table>

返回格式示例

{
        "code": 200,
        "data": {
            "details": [
                {               
                    "pid": "string", //应用对应的pid
                    "regionId": "string",                
                    "serviceName": "string" //应用名称
                }
            ],
            "services":[ //应用名称列表
               "string",
               "string"
            ]
        },
        "success": true
    }

Postman调用结果

参数设置：\_userId= 121827433423\*\*\*\*

![5.jpg][]

图5：Postman调用结果

## 4. 应用描述 ##

从ARMS中取得应用拓扑数据、曲线图、应用监控指标数据，将通过大屏DataV展示。

![6.jpg][]

图6：DataV展示

## 5. 查询接口调用次数 ##

通过/metric/Metric.json接口获得应用相关性能数据，查询接口调用次数。

API说明

*  URL ：`http://arms.console.example.com:8099/metric/Metric.json`
 *  接口说明：

<table> 
 <thead> 
  <tr> 
   <td>字段名称</td> 
   <td>字段类型</td> 
   <td>字段含义</td> 
   <td>是否必选</td> 
   <td>备注</td> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>startTime</td> 
   <td>Long</td> 
   <td>查询数据的起始时间</td> 
   <td>是</td> 
   <td>无</td> 
  </tr> 
  <tr> 
   <td>endTime</td> 
   <td>Long</td> 
   <td>查询数据的截止时间</td> 
   <td>是</td> 
   <td>无</td> 
  </tr> 
  <tr> 
   <td>intervalInSec</td> 
   <td>Integer</td> 
   <td>时间间隔</td> 
   <td>否</td> 
   <td>建议填写</td> 
  </tr> 
  <tr> 
   <td>metric</td> 
   <td>String</td> 
   <td>metric字段</td> 
   <td>是</td> 
   <td>详细填写参考参数填写示范</td> 
  </tr> 
  <tr> 
   <td>filters</td> 
   <td>List[String]</td> 
   <td>过滤字段</td> 
   <td>是</td> 
   <td>详细填写参考参数填写示范</td> 
  </tr> 
  <tr> 
   <td>measures</td> 
   <td>List[String]</td> 
   <td>指标</td> 
   <td>是</td> 
   <td>详细填写参考参数填写示范</td> 
  </tr> 
  <tr> 
   <td>dimensions</td> 
   <td>List[String]</td> 
   <td>维度</td> 
   <td>是</td> 
   <td>详细填写参考参数填写示范</td> 
  </tr> 
  <tr> 
   <td>orderBy</td> 
   <td>String</td> 
   <td>排序字段</td> 
   <td>否</td> 
   <td>无</td> 
  </tr> 
  <tr> 
   <td>sortOrder</td> 
   <td>String</td> 
   <td>排序</td> 
   <td>否</td> 
   <td>默认不排序(ASC或者DESC)</td> 
  </tr> 
  <tr> 
   <td>limit</td> 
   <td>Integer</td> 
   <td>返回条数</td> 
   <td>否</td> 
   <td>无</td> 
  </tr> 
  <tr> 
   <td>_userId</td> 
   <td>String</td> 
   <td>用户id</td> 
   <td>是</td> 
   <td>用户名称(如arms_admin)</td> 
  </tr> 
 </tbody> 
</table>

调用示例

查询指定应用过往7天的接口调用次数

参数填写示范：

<table> 
 <thead> 
  <tr> 
   <td>字段名称</td> 
   <td>字段类型</td> 
   <td>字段含义</td> 
   <td>必选</td> 
   <td>示例值</td> 
   <td>值来源</td> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>startTime</td> 
   <td>Long</td> 
   <td>查询数据的起始时间</td> 
   <td>是</td> 
   <td>1578199319898</td> 
   <td>系统时间</td> 
  </tr> 
  <tr> 
   <td>endTime</td> 
   <td>Long</td> 
   <td>查询数据的截止时间</td> 
   <td>是</td> 
   <td>1578804119898</td> 
   <td>系统时间</td> 
  </tr> 
  <tr> 
   <td>intervalInSec</td> 
   <td>Integer</td> 
   <td>时间间隔</td> 
   <td>否</td> 
   <td>默认3600秒，即1小时</td> 
   <td>人工设置</td> 
  </tr> 
  <tr> 
   <td>metric</td> 
   <td>String</td> 
   <td>metric字段，查询的指标</td> 
   <td>是</td> 
   <td>APPSTAT.DETAIL</td> 
   <td>人工设置</td> 
  </tr> 
  <tr> 
   <td>filters</td> 
   <td>List[String]</td> 
   <td>过滤字段,严格按照格式，否则调用出错</td> 
   <td>是</td> 
   <td>[{key=pid,value=1218274334230390@db61f75c2f******},{key=regionId,value=cn-******-d01}]</td> 
   <td>Pid、regionid来自于专有云环境</td> 
  </tr> 
  <tr> 
   <td>measures</td> 
   <td>List[String]</td> 
   <td>指标</td> 
   <td>是</td> 
   <td>[rt,count,error,errrate]</td> 
   <td>API文档</td> 
  </tr> 
  <tr> 
   <td>dimensions</td> 
   <td>List[String]</td> 
   <td>维度</td> 
   <td>是</td> 
   <td>[pid,rpcType,rootIp]</td> 
   <td>API文档</td> 
  </tr> 
  <tr> 
   <td>orderBy</td> 
   <td>String</td> 
   <td>排序字段</td> 
   <td>否</td> 
   <td>无</td> 
   <td>无</td> 
  </tr> 
  <tr> 
   <td>sortOrder</td> 
   <td>String</td> 
   <td>排序</td> 
   <td>否</td> 
   <td>默认不排序(ASC或者DESC)</td> 
   <td>无</td> 
  </tr> 
  <tr> 
   <td>limit</td> 
   <td>Integer</td> 
   <td>返回条数</td> 
   <td>否</td> 
   <td>无</td> 
   <td>无</td> 
  </tr> 
  <tr> 
   <td>_userId</td> 
   <td>String</td> 
   <td>用户id</td> 
   <td>是</td> 
   <td>121827433423****</td> 
   <td>无</td> 
  </tr> 
 </tbody> 
</table>

查询结果

参数设置：

![7.jpg][]

图7：参数设置

结果说明：

*  返回结果为JSON数据集。
 *  数据集会标示查询状态，成功返回200，如果失败会返回相应的错误码和错误原因。典型错误例如缺少必要参数、身份认证错误等（是因为filters参数没按格式要求写好）。
 *  OpenAPI返回的结果集组织形式与查询数据的开始时间、结束时间、数据间隔时间有关。本次查询是查询了过往7天，数据间隔时间设置成了24小时，所以这个结果集里返回了7个”data”的集合。
 *  每个data里包括在“measure”和”dimension”里指定的查询，以本结果集为例，就包括：Count:0.0  
    PID:  
    rpcDesc: HTTP入口  
    rpcType:0（HTTP调用）
 *  调整查询的开始、结束、间隔时间，会影响data数据的条数，调整接口查询参数会影响每条data里的数据。
 *  如果需要计算一些聚合值，比如过往7天总的HTTP调用次数，需要自行把多条data数据进行计算相加后得出结果。

## 6. 查询异常数量 ##

通过/metric/Metric.json 接口获得应用相关性能数据，查询异常数量。

API说明

*  URL ：`http://arms.console.example.com:8099/metric/Metric.json`
 *  接口说明：

<table> 
 <thead> 
  <tr> 
   <td>字段名称</td> 
   <td>字段类型</td> 
   <td>字段含义</td> 
   <td>是否必选</td> 
   <td>备注</td> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>startTime</td> 
   <td>Long</td> 
   <td>查询数据的起始时间</td> 
   <td>是</td> 
   <td>无</td> 
  </tr> 
  <tr> 
   <td>endTime</td> 
   <td>Long</td> 
   <td>查询数据的截止时间</td> 
   <td>是</td> 
   <td>无</td> 
  </tr> 
  <tr> 
   <td>intervalInSec</td> 
   <td>Integer</td> 
   <td>时间间隔</td> 
   <td>否</td> 
   <td>建议填写</td> 
  </tr> 
  <tr> 
   <td>metric</td> 
   <td>String</td> 
   <td>metric字段</td> 
   <td>是</td> 
   <td>详细填写参考下文</td> 
  </tr> 
  <tr> 
   <td>filters</td> 
   <td>List[String]</td> 
   <td>过滤字段</td> 
   <td>是</td> 
   <td>详细填写参考下文</td> 
  </tr> 
  <tr> 
   <td>measures</td> 
   <td>List[String]</td> 
   <td>指标</td> 
   <td>是</td> 
   <td>详细填写参考下文</td> 
  </tr> 
  <tr> 
   <td>dimensions</td> 
   <td>List[String]</td> 
   <td>维度</td> 
   <td>是</td> 
   <td>详细填写参考下文</td> 
  </tr> 
  <tr> 
   <td>orderBy</td> 
   <td>String</td> 
   <td>排序字段</td> 
   <td>否</td> 
   <td>无</td> 
  </tr> 
  <tr> 
   <td>sortOrder</td> 
   <td>String</td> 
   <td>排序</td> 
   <td>否</td> 
   <td>默认不排序(ASC或者DESC)</td> 
  </tr> 
  <tr> 
   <td>limit</td> 
   <td>Integer</td> 
   <td>返回条数</td> 
   <td>否</td> 
   <td>无</td> 
  </tr> 
  <tr> 
   <td>_userId</td> 
   <td>String</td> 
   <td>用户id</td> 
   <td>是</td> 
   <td>用户名称(如arms_admin)</td> 
  </tr> 
 </tbody> 
</table>

调用示例

查询指定应用过往7天的接口调用次数。

参数填写示范：

<table> 
 <thead> 
  <tr> 
   <td>字段名称</td> 
   <td>字段类型</td> 
   <td>字段含义</td> 
   <td>必选</td> 
   <td>示例值</td> 
   <td>值来源</td> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>startTime</td> 
   <td>Long</td> 
   <td>查询数据的起始时间</td> 
   <td>是</td> 
   <td>1577980826988</td> 
   <td>系统时间</td> 
  </tr> 
  <tr> 
   <td>endTime</td> 
   <td>Long</td> 
   <td>查询数据的截止时间</td> 
   <td>是</td> 
   <td>1578585626989</td> 
   <td>系统时间</td> 
  </tr> 
  <tr> 
   <td>intervalInSec</td> 
   <td>Integer</td> 
   <td>时间间隔</td> 
   <td>否</td> 
   <td>默认3600秒，即1小时</td> 
   <td>人工设置</td> 
  </tr> 
  <tr> 
   <td>metric</td> 
   <td>String</td> 
   <td>metric字段，查询的指标</td> 
   <td>是</td> 
   <td>APPSTAT.EXCEPTION</td> 
   <td>人工设置</td> 
  </tr> 
  <tr> 
   <td>filters</td> 
   <td>List[String]</td> 
   <td>过滤字段,严格按照格式，否则调用出错。</td> 
   <td>是</td> 
   <td>[{key=pid,value=1218274334230390@db61f75c2f******},{key=regionId,value=cn-******-d01}]</td> 
   <td>Pid、regionid来自于专有云环境</td> 
  </tr> 
  <tr> 
   <td>measures</td> 
   <td>List[String]</td> 
   <td>指标</td> 
   <td>是</td> 
   <td>[count]</td> 
   <td>API 文档</td> 
  </tr> 
  <tr> 
   <td>dimensions</td> 
   <td>List[String]</td> 
   <td>维度</td> 
   <td>是</td> 
   <td>[pid,rpc,endpoint,exceptionInfo]</td> 
   <td>API文档</td> 
  </tr> 
  <tr> 
   <td>orderBy</td> 
   <td>String</td> 
   <td>排序字段</td> 
   <td>否</td> 
   <td>无</td> 
   <td>无</td> 
  </tr> 
  <tr> 
   <td>sortOrder</td> 
   <td>String</td> 
   <td>排序</td> 
   <td>否</td> 
   <td>默认不排序(ASC或者DESC)</td> 
   <td>无</td> 
  </tr> 
  <tr> 
   <td>limit</td> 
   <td>Integer</td> 
   <td>返回条数</td> 
   <td>否</td> 
   <td>无</td> 
   <td>无</td> 
  </tr> 
  <tr> 
   <td>_userId</td> 
   <td>String</td> 
   <td>用户id</td> 
   <td>是</td> 
   <td>1218274334230390</td> 
   <td>无</td> 
  </tr> 
 </tbody> 
</table>

查询结果

参数设置：

![8.jpg][]

图8：参数设置

查询结果：

![9.jpg][]

图9：查询结果

结果说明：

*  返回结果为JSON数据集。
 *  数据集会标示查询状态，成功返回200，如果失败会返回相应的错误码和错误原因。典型错误例如缺少必要参数、身份认证错误等（是因为filters参数没按格式要求写好）。
 *  本次查询未查到相关数据，所以exception数量为0。

## 7. 查询当前应用实例数量 ##

通过/metric/Metric.json接口获得应用相关性能数据，查询当前应用实例数量。

API说明

*  URL ：`http://arms.console.example.com:8099/metric/Metric.json`
 *  接口说明：

<table> 
 <thead> 
  <tr> 
   <td>字段名称</td> 
   <td>字段类型</td> 
   <td>字段含义</td> 
   <td>是否必选</td> 
   <td>备注</td> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>startTime</td> 
   <td>Long</td> 
   <td>查询数据的起始时间</td> 
   <td>是</td> 
   <td>无</td> 
  </tr> 
  <tr> 
   <td>endTime</td> 
   <td>Long</td> 
   <td>查询数据的截止时间</td> 
   <td>是</td> 
   <td>无</td> 
  </tr> 
  <tr> 
   <td>intervalInSec</td> 
   <td>Integer</td> 
   <td>时间间隔</td> 
   <td>否</td> 
   <td>建议填写</td> 
  </tr> 
  <tr> 
   <td>metric</td> 
   <td>String</td> 
   <td>metric字段</td> 
   <td>是</td> 
   <td>详细填写参考下文</td> 
  </tr> 
  <tr> 
   <td>filters</td> 
   <td>List[String]</td> 
   <td>过滤字段</td> 
   <td>是</td> 
   <td>详细填写参考下文</td> 
  </tr> 
  <tr> 
   <td>measures</td> 
   <td>List[String]</td> 
   <td>指标</td> 
   <td>是</td> 
   <td>详细填写参考下文</td> 
  </tr> 
  <tr> 
   <td>dimensions</td> 
   <td>List[String]</td> 
   <td>维度</td> 
   <td>是</td> 
   <td>详细填写参考下文</td> 
  </tr> 
  <tr> 
   <td>orderBy</td> 
   <td>String</td> 
   <td>排序字段</td> 
   <td>否</td> 
   <td>无</td> 
  </tr> 
  <tr> 
   <td>sortOrder</td> 
   <td>String</td> 
   <td>排序</td> 
   <td>否</td> 
   <td>默认不排序(ASC或者DESC)</td> 
  </tr> 
  <tr> 
   <td>limit</td> 
   <td>Integer</td> 
   <td>返回条数</td> 
   <td>否</td> 
   <td>无</td> 
  </tr> 
  <tr> 
   <td>_userId</td> 
   <td>String</td> 
   <td>用户id</td> 
   <td>是</td> 
   <td>用户名称(如arms_admin)</td> 
  </tr> 
 </tbody> 
</table>

调用示例

查询指定应用过往7天的接口调用次数。

参数填写示范：

<table> 
 <thead> 
  <tr> 
   <td>字段名称</td> 
   <td>字段类型</td> 
   <td>字段含义</td> 
   <td>必选</td> 
   <td>示例值</td> 
   <td>值来源</td> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>startTime</td> 
   <td>Long</td> 
   <td>查询数据的起始时间</td> 
   <td>是</td> 
   <td>1577980826988</td> 
   <td>系统时间</td> 
  </tr> 
  <tr> 
   <td>endTime</td> 
   <td>Long</td> 
   <td>查询数据的截止时间</td> 
   <td>是</td> 
   <td>1578585626989</td> 
   <td>系统时间</td> 
  </tr> 
  <tr> 
   <td>intervalInSec</td> 
   <td>Integer</td> 
   <td>时间间隔</td> 
   <td>否</td> 
   <td>默认3600秒，即1小时</td> 
   <td>人工设置</td> 
  </tr> 
  <tr> 
   <td>metric</td> 
   <td>String</td> 
   <td>metric字段，查询的指标</td> 
   <td>是</td> 
   <td>APPSTAT.DETAIL</td> 
   <td>人工设置</td> 
  </tr> 
  <tr> 
   <td>filters</td> 
   <td>List[String]</td> 
   <td>过滤字段,严格按照格式，否则调用出错。</td> 
   <td>是</td> 
   <td>[{key=pid,value=1218274334230390@db61f75c2f28609},{key=regionId,value=******}]</td> 
   <td>Pid、regionid来自于专有云环境</td> 
  </tr> 
  <tr> 
   <td>measures</td> 
   <td>List[String]</td> 
   <td>指标</td> 
   <td>是</td> 
   <td>[count]</td> 
   <td>API 文档</td> 
  </tr> 
  <tr> 
   <td>dimensions</td> 
   <td>List[String]</td> 
   <td>维度</td> 
   <td>是</td> 
   <td>[pid,rootIp]</td> 
   <td>API文档</td> 
  </tr> 
  <tr> 
   <td>orderBy</td> 
   <td>String</td> 
   <td>排序字段</td> 
   <td>否</td> 
   <td>无</td> 
   <td>无</td> 
  </tr> 
  <tr> 
   <td>sortOrder</td> 
   <td>String</td> 
   <td>排序</td> 
   <td>否</td> 
   <td>默认不排序(ASC或者DESC)</td> 
   <td>无</td> 
  </tr> 
  <tr> 
   <td>limit</td> 
   <td>Integer</td> 
   <td>返回条数</td> 
   <td>否</td> 
   <td>无</td> 
   <td>无</td> 
  </tr> 
  <tr> 
   <td>_userId</td> 
   <td>String</td> 
   <td>用户id</td> 
   <td>是</td> 
   <td>12182743342******</td> 
   <td>无</td> 
  </tr> 
 </tbody> 
</table>

查询结果

参数设置：

![10.jpg][]

图10：参数设置

查询结果：

![11.jpg][]

图11：查询结果

结果说明：

*  返回结果为JSON数据集。
 *  数据集会标示查询状态，成功返回200，如果失败会返回相应的错误码和错误原因。典型错误例如缺少必要参数、身份认证错误等（是因为filters参数没按格式要求写好）。
 *  Openapi返回的结果集组织形式与查询数据的开始时间、结束时间、数据间隔时间有关。本次查询是查询了过往7天，数据间隔时间设置成了24小时，所以这个结果集里返回了7个”data”的集合。
 *  每个data里包括在**measure**和**dimension**里指定的查询，以本结果集为例，就包括：Count:0.0  
    RootIP
 *  本次查询需求是要看此应用一共部署了多少实例，所以对结果中不同IP进行计算，即可以算出共有多少实例数量。另外一个方法是设置intervalInSec的值，让它等查询区间，这样出来的data集合的条数就是实例数量值，因为每个IP都会有条数据。

## 8. 查询当前应用拓扑图 ##

通过/trace/Dependecies.json接口获得应用拓扑相关数据。

API说明

*  URL ：`http://arms.console.example.com:8099/trace/Dependecies.json`
 *  接口说明：

调用示例

查询指定应用过往7天的接口调用次数。

参数填写示范：

本测试1月12日进行，查询过去7天的数据。

<table> 
 <thead> 
  <tr> 
   <td>字段名称</td> 
   <td>字段类型</td> 
   <td>字段含义</td> 
   <td>必选</td> 
   <td>示例值</td> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>startTime</td> 
   <td>Long</td> 
   <td>查询数据的起始时间</td> 
   <td>是</td> 
   <td>1578199319898 （1月5日）</td> 
  </tr> 
  <tr> 
   <td>endTime</td> 
   <td>Long</td> 
   <td>查询数据的截止时间</td> 
   <td>是</td> 
   <td>1578804119898 （1月12日）</td> 
  </tr> 
  <tr> 
   <td>_userId</td> 
   <td>String</td> 
   <td>用户id</td> 
   <td>是</td> 
   <td>1218274334******</td> 
  </tr> 
  <tr> 
   <td>type</td> 
   <td>String</td> 
   <td>查询类型</td> 
   <td>是</td> 
   <td>APP</td> 
  </tr> 
  <tr> 
   <td>pid</td> 
   <td>String</td> 
   <td>应用对应的pid</td> 
   <td>否</td> 
   <td>1218274334230390@db61f75c******</td> 
  </tr> 
 </tbody> 
</table>

查询结果

参数设置：

![12.jpg][]

图12：参数设置

查询结果：

{
        "code": 200,
        "data": {
            "link": [{
        "code": 200,
        "data": {
            "link": [
                {
                    "callCount": 26997.0,
                    "child": "Demo-Service",
                    "childNodeId": 731107445,
                    "childPid": "1218274334230390@db61f75c2******",
                    "elapsed": 16.2328,
                    "errorCount": 16.0,
                    "parent": "USER",
                    "parentNodeId": 812148234,
                    "parentPid": "1218274334230390@db61f75c2******",
                    "protocol": "HTTP"
                },
                {
                    "callCount": 8.0,
                    "child": "pdsa_lhh_rocketmq",
                    "childNodeId": -1762019072,
                    "childPid": "pdsa_lhh_rocketmq",
                    "elapsed": 11190.5,
                    "errorCount": 8.0,
                    "parent": "Demo-Service",
                    "parentNodeId": 731107445,
                    "parentPid": "1218274334230390@db61f75c2******",
                    "protocol": "AliWareMQ"
                }
            ],
            "nodes": [
                {
                    "elapsed": 0.0,
                    "errorCount": 0.0,
                    "id": 812148234,
                    "name": "USER",
                    "pid": "1218274334230390@db61f75c2******",
                    "requestCount": 0.0,
                    "type": "USER"
                },
                {
                    "elapsed": 0.0,
                    "errorCount": 0.0,
                    "id": 731107445,
                    "name": "Demo-Service",
                    "pid": "1218274334230390@db61f75c2******",
                    "requestCount": 0.0,
                    "type": "MQ_PRODUCER"
                },
                {
                    "elapsed": 0.0,
                    "errorCount": 0.0,
                    "id": -1762019072,
                    "name": "pdsa_****_rocketmq",
                    "pid": "pdsa_****_rocketmq",
                    "requestCount": 0.0,
                    "type": "METAQ"
               }
           ]
        },
        "success": true
    }

实际拓扑图效果如下：

![13.jpg][]

图13：拓扑图

结果说明：

*  返回结果为JSON数据集。
 *  数据集会标示查询状态，成功返回200，如果失败会返回相应的错误码和错误原因。典型错误例如缺少必要参数、身份认证错误等（是因为filters参数没按格式要求写好）。
 *  查询结果是一个点线图的节点数据和连接数据，需要使用者自行按照图表控件组装相应数据。

[原文链接][Link 1]

本文为阿里云原创内容，未经允许不得转载。

[56f5ded39bcc4efc94ff1398a9db9782.png]: /images/20220829/efa03a4ef71f4546b1936a62212f9f39.png
[1.jpg]: /images/20220829/9da03a75e70d4482af70c48e8dde1ccb.png
[2.jpg]: /images/20220829/ad08602023d04537a66d375f36f714f1.png
[3.jpg]: /images/20220829/063d8921283a4f2dba55dc9fe2b83cd9.png
[4.jpg]: /images/20220829/85c9948fcb2142558255f1e9d5160b82.png
[5.jpg]: /images/20220829/b48bee56cf3e497bbe138ff323d7b142.png
[6.jpg]: /images/20220829/6feada45adfc4bf198f395ca6891bc81.png
[7.jpg]: /images/20220829/1cb386c0c71544c0b3788a8aff57c9cf.png
[8.jpg]: /images/20220829/e0627824911144d0b63766f25ec22dda.png
[9.jpg]: /images/20220829/92670b714d284d0fad0b3c5f8547724a.png
[10.jpg]: /images/20220829/8552d29c12c84c0896ba468cdf9539a0.png
[11.jpg]: /images/20220829/e5f0797c227c44e3a0165ea3580aa432.png
[12.jpg]: /images/20220829/c808a458d42a4bdb93b51134cc3da064.png
[13.jpg]: /images/20220829/5956edef4ac14439894ce0bc46c66aad.png
[Link 1]: http://click.aliyun.com/m/1000284240/