OpenAPI监控列表_全域采集与增长分析(Quick Tracking)-阿里云帮助中心

说明

该功能在2.4.19版本开放，低于2.4.19版本的用户如需该功能请联系售后同学升级产品版本。

身份验证

鉴权依据

API ID、API Secret

注：由于数据敏感，所以只在主账号中可见，具体展示位置为：

“管理控制台” -->“采集信息”

URL参数

http://{yourDomain}/api/{service}?api_id={yourAppId}&api_sign={yourSign}&api_ts={currentTimeStamp}

参数名	描述	备注
api_id	API ID	Quick Tracking后台主账号可查看
api_sign	签名	具体逻辑见“鉴权签名”
api_ts	时间戳	毫秒

body参数

{
 "param1": "value1",
 "param2": "value2",
 	"param3": "value3"
}

鉴权签名

方法名 + 参数按照key进行字母排序

/**
 * Quick Tracking后台主账号可查看
 */
String secret = "yourAppSecret";

/**
 * 当前要请求的服务名
 */
String service = "oxm.monitor.message.list";

/**
 * 1.获取url参数，如apiId={yourAppId}&sign={yourSign}&ts={currentTimestamp}
 * 2.按照key排序，移除sign，结果apiId=abcdef&ts=123456
 */
String queryString = sort("api_id={yourAppId}&api_ts={currentTimestamp}");

/**
 * POST接口，body内容
 */
String bodyString = "{
 "param1": "value1",
 "param2": "value2",
 	"param3": "value3"
}";

String source = service
 + "\n" 
 + queryString
 + "\n"
 + bodyString;

用API Secret对source进行加密

String sign = new HmacUtils(HmacAlgorithms.HMAC_SHA_1, secret).hmacHex(source);

<dependency>
 <groupId>com.squareup.okhttp3</groupId>
 <artifactId>okhttp</artifactId>
 <version>3.3.0</version>
</dependency>

service

oxm.monitor.message.list

请求参数构建

DEMO

{
 "startTime": "2023-07-03 00:00:00",
 "endTime": "2023-07-03 23:59:59"
}

字段名称	字段含义	是否必填	备注
startTime	开始时间	必填
endTime	结束时间	必填

返回结果

{
  "gmtCreate": "2023-07-03 23:18:37",
  "gmtModified": "2023-07-03 23:18:37",
  "creatorId": 0,
  "creatorName": "system",
  "modifierId": 0,
  "modifierName": "system",
  "tenantId": 租户ID,
  "monitorTaskId": 58962306097861,
  "monitorTaskName": "监控名称",
  "orgId": 1234567890,
  "orgName": "组织名称",
  "appInfoId": 12121212,
  "appName": "应用名称",
  "bizRule": {
    "indicatorRule": {
      "indicators": [
        {
          "indicator": {
            "calculationMethod": "pv",
            "desc": "任意事件(预置)的设备ID的触发次数",
            "event": {
              "name": "$$_any_event",
              "displayName": "任意事件(预置)",
              "subClass": "event",
              "eventType": "other"
            },
            "property": {
              "displayName": "设备ID",
              "name": "deviceID"
            },
            "lv1Value": "presetIndicator"
          }
        }
      ]
    },
    "groupProperties": [
      {
        "propertyRule": {},
        "monitorRule": [
          {
            "operation": {
              "key": ">",
              "name": "高于"
            },
            "compareTo": {
              "compareType": "FIXED",
              "timeValue": 1,
              "valueType": "NUMBER",
              "value": "1"
            }
          }
        ]
      }
    ]
  },
  "msgType": "INDICATOR_EXCEPTION",
  "msgList": [
    "「总体」指标为41463.0，高于固定值1"
  ]
}

monitorTaskName	监控名称
bizRule.indicatorRule.indicators[i].indicator.desc	监控指标名称
msgList	异常摘要
orgName	组织名称（3.0.0版本及以上存在）
appName	应用名称（3.0.0版本及以上存在）
appInfoId	应用编码（3.0.0版本及以上存在）

异常摘要规则如下，{}内的为您在QuickTracking设置监控时自定义的内容：

「总体」指标值为 {计算结果} ，高于/低于固定值 xxx
「{属性名称} {属性值}」指标值为 {计算结果} ，高于/低于固定值 xxx
「总体」指标值为 {计算结果} ，高于/低于上5分钟/上一小时/昨天/昨天同期/上周同期 xxx / xxx%
「{属性名称} {属性值}」指标值为 {计算结果} ，高于/低于上5分钟/上一小时/昨天/昨天同期/上周同期 xxx / xxx%
「总体」指标值为 {计算结果} ，区间在 {低值} 到 {高值}
「{属性名称} {属性值}」指标值为 {计算结果} ，区间在 {低值} 到 {高值}
「总体」指标值为 {计算结果} ，区间不在 {低值} 到 {高值}
「{属性名称} {属性值}」指标值为 {计算结果} ，区间不在 {低值} 到 {高值}