該功能在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%
「總體」指標值為 {計算結果} ,區間在 {低值} 到 {高值}
「{屬性名稱} {屬性值}」 指標值為 {計算結果} , 區間在 {低值} 到 {高值}
「總體」指標值為 {計算結果} ,區間不在 {低值} 到 {高值}
「{屬性名稱} {屬性值}」 指標值為 {計算結果} , 區間不在 {低值} 到 {高值}