# 数字空间告警接口

# 1. 获取告警列表

请求url：/space/datahub/alarm/v0.1/getAlarmList
请求方法：GET
请求参数：

参数名	参数类型	说明	是否必填
token	String	鉴权token	是
type	String	告警类型	否
status	String	状态 processed unprocessed processing	否
subType	String	告警子类型	否
level	int	告警级别 1-5	否
beginTime	String	开始时间 yyyyMMddHHmmss	是
endTime	String	结束时间 yyyyMMddHHmmss	是
id	String	告警id	否
appIds	String	上报的appid列表，英文逗号分隔	否
imgFlag	boolean	是否返回告警的图片信息	否
page	int	页码，默认1	否
size	int	每页数量，默认10	否
project_id	int	项目ID	否
executeId	String	执行ID，可以支持关联告警消息的快速条件检索，格式：字母（自动转小写）、数字、横杠“-”、点“.”、下划线“_”，长度：36字符，若格式不对，将直接置空	否
poiId	String	POI编号	否

请求示例：

https://apitest.welink.qq.com/space/datahub/alarm/v0.1/getAlarmList
?project_id=······
&token=·············
&subType=·············

1
2
3
4

返回参数：

参数名	参数类型	描述
code	Int	返回码
data	JsonObject	返回数据
success	boolean	是否成功

返回示例：

{
    "code":0,
    "data":{
        "size":1,
        "data":[
            {
                "image":{
                    "data":"abfa497c-a019-4fbc-8262-f8567236a0df",//图片fileID，使用应用api 11.2 cos接口下载
                    "type":3
                },
                "handler":{
										"type": "", //处理方式："url" (打开链接处理) , "other"（其他处理方式）
										"data": "" //对应的url或者其他的处理方式
                },//处理方式，
                "execute_id":"",//执行ID
                "level":3,//告警等级
                "advice":"",//告警处理建议
                "sub_type_cn":"安全帽检测",//事件子业务类型
                "description":"",//事件描述
                "type":"security_monitoring",//事件业务类型
                "processor":[
                    {
                        "name":"李XX",
                        "id":"31937"
                    },
                    {
                        "name":"XXgui",
                        "id":"59758"
                    }
                ],//处理人信息
                "process_time":"1637744103002",//处理时间
                "process_description":"",//处理描述
                "extend":{

                },//拓展信息，上报的数据内容，放在这里
                "wid":"025e3653-fecc-462f-8857-21e5138123116",
                "referId":"025e3653-fecc-462f-8857-21e5138123116",//关联设备wId
                "sub_type":"safety_helmet",
                "type_cn":"安防监控",
                "process_extend":{

                },
                "id":"4933fda2-7519-49c2-b302-631a74324b68",
                "time":"1637744102364",
                "position":{
                    "innerHeight":0,
                    "level":9,
                    "latitude":22.5224714909961,
                    "din":"144115192498589396",
                    "building":"腾讯滨海大厦",
                    "position_text":"腾讯滨海大厦_F7_东走道_AFJK000",
                    "device_name":"F7_东走道_AFJK000",
                    "wId":"025e3653-fecc-462f-8857-21e5138123116",
                    "dt_name":"半球摄像头",
                    "cad_floor":"F7",
                    "area_info":"",
                    "poi_id":"4403002230221007_9",
                    "height":37.5,
                    "longitude":113.935214671757
                },//设备位置信息
                "repeatNum":0,
                "app_id":41202,
                "status":"processing"//处理状态
            }
        ],
        "count":96267,
        "page":1
    },
    "success":true
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

# 2. 处理告警记录

请求url:/space/datahub/alarm/v0.1/changeStatus
请求方法：POST
请求参数：

参数名	参数类型	说明	示例	是否必填
uuid	String	告警的uuid，返回的列表中的id	uuid=790453a6-9ca4-45bc-a814-59359f5b4715	是
status	String	告警状态 processed unprocessed processing misreport shield	status=unprocessed	是
processor	String	告警处理人，可以为JSON字符串，处理人信息从微瓴平台获取	processor=[{"val": "XXX@qq.com", "name": "XXX", "id": "31603"}]	是
processTime	Long	告警处理时间	processTime=1594738943979	是
advice	String	告警处理建议		否
processDescription	String	告警处理的描述信息		否
processExtend	String	告警处理的扩展信息，可以为JSON字符串		否
token	String	鉴权	token=XXX	是

注意：参数均放在URL里面，需要urlEncode。

请求示例：

https://apitest.welink.qq.com/space/datahub/alarm/v0.1/changeStatus
?uuid=790453a6-9ca4-45bc-a814-59359f5b4715
&processTime=1594738943979
&status=processed
&processor=[{"val": "XXX@qq.com", "name": "XXX", "id": "31603"}]
&token=
&processDescription=
&processExtend={}

1
2
3
4
5
6
7
8

返回参数：

参数名	参数类型	描述
code	Int	返回码
success	boolean	是否成功

返回示例：

{
  "code": 0,
  "success": true
}

1
2
3
4

# 3. 根据类型级别状态统计告警信息

请求url：/space/datahub/alarm/v0.1/getCountByTypeAndLevelAndStatus
请求方法：GET
请求参数：

参数名	参数类型	说明	是否必填
type	String	告警类型	否
status	String	状态 processed unprocessed processing misreport shield	否
level	String	告警级别	否
token	String	鉴权token	是
isAll	Boolean	是否统计全量告警数据（包括被收敛的），默认false	否

请求示例：

https://apitest.welink.qq.com/space/datahub/alarm/v0.1/getCountByTypeAndLevelAndStatus?token=

返回参数：

参数名	参数类型	描述
code	Int	返回码
data	JsonObject	返回数据
success	boolean	是否成功

返回示例：

{
  "code": 0,
  "data": {
    "people_flow": {  //告警类型
      "77777": {   //appid，0为设备告警，6666为联动下发告警
        "3": 1115,   //"告警等级"：告警数量
        "5": 1103
      }
    },
    "device": {
      "40405": {
        "4": 31
      }
    },
    "security_monitoring": {
      "30248": {
        "1": 3
      },
      "6666": {
        "2": 3
      }
    }
  },
  "success": true
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

# 4. 根据告警类型状态起始时间统计告警信息

请求url：/space/datahub/alarm/v0.1/getStatisticsData
请求方法：GET
请求参数：

参数名	参数类型	说明	是否必填
type	String	告警类型	否
status	String	状态 processed unprocessed processing misreport shield	否
beginTime	String	开始时间yyyyMMddHHmmss	否
endTime	String	结束时间yyyyMMddHHmmss	否
appIds	String	告警上报的appid，英文逗号分隔	否
token	String	鉴权token	是
isAll	Boolean	是否统计全量告警数据（包括收敛的告警）默认false	否

请求示例:

https://apitest.welink.qq.com/space/datahub/alarm/v0.1/getStatisticsData?token=

返回参数：

参数名	参数类型	描述
code	Int	返回码
data	JsonObject	返回数据
success	boolean	是否成功

返回示例：

{
  "code": 0,
  "data": {
    "count": 4
  },
  "success": true
}

1
2
3
4
5
6
7

# 5. 根据告警类型状态起始时间按照时间间隔统计告警信息

请求url：/space/datahub/alarm/v0.1/getStatisticsDataByStep
请求方法：GET
请求参数：

参数名	参数类型	说明	是否必填
type	String	告警类型	否
status	String	状态 processed unprocessed processing misreport shield	否
beginTime	String	开始时间yyyyMMddHH	是
endTime	String	结束时间yyyyMMddHH	是
appIds	String	告警上报的appid，英文逗号分隔	否
step	int	时间间隔，默认3600s	否
token	String	鉴权token	是
isAll	Boolean	是否统计全量告警数据（包含收敛数据），默认false	否

请求示例：

https://apitest.welink.qq.com/space/datahub/alarm/v0.1/getStatisticsDataByStep?
token=
&step=3600
&beginTime=2019041511
&&endTime=2019041523

1
2
3
4
5

返回参数：

参数名	参数类型	描述
code	Int	返回码
data	JsonObject	返回数据
success	boolean	是否成功

返回示例：

{
  "code": 0,
  "data": {
    "2019041511": 23,//"日期":数量
    "2019041512": 24,
    "2019041513": 23,
    "2019041514": 24,
    "2019041515": 24,
    "2019041516": 24,
    "2019041517": 24,
    "2019041518": 24,
    "2019041519": 22,
    "2019041520": 24
  },
  "success": true
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

# 6. 批量获取告警图片信息

请求url：/space/datahub/alarm/v0.1/getImageByIds
请求方法：POST
请求参数：

header: Content-Type: application/json

body: ArrayList: ["275fd36f-9487-4428-a92a-e307f725796e", "1e87792a-5351-4e5d-8ddc-f8b84805b931"]
返回参数：

参数名	参数类型	描述
code	Int	返回码
data	JsonArray	返回数据
image.data	String	fileIdid，使用文件下载接口 (opens new window)下载
image.type	String	文件类型
success	boolean	是否成功

返回示例：

{
    "code":0,
    "data":[
        {
            "image":{
                "data":"cb5709b5-cb46-4b1d-8c44-3c03fc130bd9",
                "type":4
            },
            "id":"1e87792a-5351-4e5d-8ddc-f8b84805b931"
        },
        {
            "image":{
                "data":"d120cc9d-3c21-4973-a9c7-8bcd473d1083",
                "type":4
            },
            "id":"275fd36f-9487-4428-a92a-e307f725796e"
        }
    ],
    "success":true
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

# 7. 批量添加告警处理记录

请求url：/space/datahub/alarm/v0.1/addProcessRecord
请求方法：POST

请求参数：

header: Content-Type: application/json

body: JSONArray 例：

[
  {
    "warningId": "3456",
    "dealTime": 1556708722342,
    "dealManager": "haiboliu",
    "dealType": "重启",
    "dealDesc": "重启修复",
    "appendixFileId": "abcdefg",
    "isValid": 0
  },
  {
    "warningId": "4589",
    "dealTime": 1556708722355,
    "dealManager": "haiboliu",
    "dealType": "重启",
    "dealDesc": "重启修复",
    "appendixFileId": "cdefeee",
    "isValid": 0
  }
]

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

返回示例：

参数名	参数类型	描述
code	Int	返回码
data	JsonArray	返回数据
success	boolean	是否成功

返回示例：

{
  "code": 0,
  "data": [
    {
      "id": 23,
      "waringId": "3456"
    }
  ],
  "success": true
}

1
2
3
4
5
6
7
8
9
10

# 8. 根据wId和时间查询人流告警信息

请求url：/space/datahub/alarm/v0.1/getPeopleFlowList
请求方法：GET
请求参数：

参数名	参数类型	说明	是否必填
wId	String	告警类型	否
beginTime	String	开始时间yyyyMMddHHmmss	否
endTime	String	结束时间yyyyMMddHHmmss	否
token	String	鉴权token	是

请求示例：

https://apitest.welink.qq.com/space/datahub/alarm/v0.1/getPeopleFlowList?token=

返回参数：

参数名	参数类型	描述
code	Int	返回码
data	JsonArray	返回数据
success	boolean	是否成功

返回示例：

{
  "code": 0,
  "data": [
    {
      "eventDatetime": "2019-05-13T11:18:04.000+0000""eventTs": 123"floor": "7F""threshold": 1"value": 2"wId": "123333"
    }
  ],
  "success": true
}

1
2
3
4
5
6
7
8
9

# 9. 根据告警id查询告警处理记录

请求url：/space/datahub/alarm/v0.1/getProcessRecord
请求方法：GET
请求参数：

参数名	参数类型	说明	是否必填
warningId	String	告警id,多个用,分隔	是
token	String	鉴权token	是

请求示例：

https://apitest.welink.qq.com/space/datahub/alarm/v0.1/getProcessRecord?
warningId=123,321
&token=

1
2
3

返回参数：

参数名	参数类型	描述
code	Int	返回码
data	JsonArray	返回数据
success	boolean	是否成功

返回示例：

{
  "code": 0,
  "data": [
    {
      "id": 1,
      "alarmId": "12345",
      "processor": "haiboliu",
      "processTime": "2019-05-01T11:05:22.000+0000",
      "processType": "重启",
      "description": "重启修复",
      "fileId": "abcdefg",
      "isValid": 0,
      "gmtCreate": "2019-05-06T09:28:40.000+0000",
      "gmtModified": "2019-05-06T09:28:40.000+0000",
      "rowStatus": 0
    }
  ],
  "success": true
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

# 10. 获取收敛的告警列表

请求url：/space/datahub/alarm/v0.1/getConvergenceAlarmList
请求方法：GET
请求参数：

参数名	参数类型	说明	是否必填
token	String	鉴权token	是
id	String	告警id	是
page	int	页码，默认1	否
size	int	每页数量，默认10，最大100	否

请求示例：

https://apitest.welink.qq.com/space/datahub/alarm/v0.1/getConvergenceAlarmList?
id=123
&token=
&page=1
&size=10

1
2
3
4
5

返回参数：

参数名	参数类型	描述
code	Int	返回码
data	JsonObject	返回数据
success	boolean	是否成功

示例示例：

{
  "code": 0,
  "data": {
    "size": 1,
    "data": [
      {
        "handler": {
          
        },
        "sub_type": "online",
        "level": 1,
        "advice": "",
        "description": "",
        "id": "",
        "time": "1552640930201",
        "position": {
          "wId": "b474ce98-04e2-4b5c-b9fd-abf3f7d8600d",
          "level": 9,
          "sub_id": "",
          "din": "144115192382209921"
        },
        "type": "device",
        "processor": {
          
        },
        "status": "processed"
      }
    ],
    "count": 5201,
    "page": 1
  },
  "success": true
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

# 11. 通用告警统计接口

# 11.1. 当前项目所含告警类型接口

功能描述：获取当前项目下所有告警类型
请求URL：/space/datahub/alarm/v0.1/getCatalog
请求方式：GET
请求参数：

参数名	类型	必填	数据约束	描述
token	String	是	非空且长度固定129个字符	动态密钥，有效期20分钟，需重新登录

请求示例：

https://domain/space/datahub/alarm/v0.1/getCatalog&token=

返回参数：

参数名	类型	描述
code	String	返回码；0表示成功，非0表示出错
data	String	返回数据
success	Boolean	返回信息；true 表示成功，false 表示出错

返回示例：

{ 
	"code": 0,
	"data": [{
		"englishName": "security_monitoring",
		"name": "安防监控"
	}, {
		"englishName": "fire_protecting",
		"name": "消防"
	}, {
		"englishName": "work_order",
		"name": "工单"
	}],
	"success": true
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14

# 11.2. 当前项目所含告警子类型接口

功能描述：获取当前项目下指定告警类型下所含告警子类型
请求URL：/space/datahub/alarm/v0.1/getSubCatalog
请求方式：GET
请求参数：

参数名	类型	必填	数据约束	描述
token	String	是	非空且长度固定129个字符	动态密钥，有效期20分钟，需重新登录
type	String	是		指定告警类型

请求示例：

https://domain/space/datahub/alarm/v0.1/getSubCatalog&type=work_order?token=

返回参数：

参数名	类型	描述
code	String	返回码；0表示成功，非0表示出错
data	String	返回数据
success	Boolean	返回信息；true 表示成功，false 表示出错

返回示例：

{
	"code": 0,
	"data": [{
		"englishName": "order_report",
		"name": "工单上报"
	}, {
		"englishName": "order_cancel",
		"name": "工单取消"
	}, {
		"englishName": "order_response",
		"name": "工单回复"
	}],
	"success": true
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14

# 11.3. 告警数据统计计数接口

功能描述：获取当前项目下指定条件下所含告警的数量
请求URL：/space/datahub/alarm/v0.1/getStatisticsData
请求方式：GET
请求参数：

参数名	类型	必填	数据约束	描述
token	String	是	非空且长度固定128个字符	动态密钥，有效期20分钟，需重新登录
type	string	否		指定告警类型
status	string	否		指定状态告警
appIds	string	否		指定appid
beginTime	string	否		指定查询时间起始
endTime	string	否		指定查询时间终止
level	integer	否		指定级别
subType	string	否		指定告警子类型

请求示例：

https://domain/space/datahub/alarm/v0.1/getStatisticsData?type=work_order&token=

返回参数：

参数名	类型	描述
code	String	返回码；0表示成功，非0表示出错
data	String	返回数据
success	Boolean	返回信息；true 表示成功，false 表示出错

返回示例：

{	"code": 0,	"data": {		"count": 84573	},	"success": true}

# 12. 告警状态统计接口

请求方式：GET
url：/space/datahub/alarm/v0.1/getStatisticsDataByTypeStatus
注：限制查询时间段间隔最长1天，遵循左闭右开

请求参数：

ID	描述	类型	备注
beginTime	开始时间	String	格式：yyyyMMHHddmmss，等价时间查询条件 >= beginTime
endTime	结束时间	String	格式：yyyyMMHHddmmss，等价时间查询条件 < endTime

请求示例：

https://domian/space/datahub/alarm/v0.1/getStatisticsDataByTypeStatus?token=XXX&beginTime=20210924140000&endTime=20210924150000

返回参数：

ID	描述	类型
code	返回码	Num
data	返回数组	Array
count	统计数量	Num
subType	子业务类型	String
type	业务类型	String
status	告警状态	String

返回示例：

{
    "code":0,
    "data":[
        {
            "count":24,
            "subType":"fire_alarm",
            "type":"fire_protecting",
            "status":"unprocessed"
        },
        {
            "count":6,
            "subType":"fire_alarm",
            "type":"fire_protecting",
            "status":"processing"
        },
        {
            "count":24,
            "subType":"retention",
            "type":"security_monitoring",
            "status":"unprocessed"
        },
        {
            "count":6,
            "subType":"retention",
            "type":"security_monitoring",
            "status":"processing"
        }
    ],
    "success":true
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

# 13. 当前项目所有告警类型

功能描述：获取当前项目下所有告警类型以及子类型（包括没有产生过的告警）
请求URL：/space/datahub/alarm/v0.1/getAllCatalog
请求方式：GET
请求参数：

参数名	类型	必填	数据约束	描述
token	String	是	非空且长度固定129个字符	动态密钥，有效期20分钟，需重新登录

请求示例：

https://domain/space/datahub/alarm/v0.1/getAllCatalog?token=

返回参数：

参数名	类型	描述
code	String	返回码；0表示成功，非0表示出错
data	String	返回数据
success	Boolean	返回信息；true 表示成功，false 表示出错

返回示例：

{
    "code": 0,
    "data": {
        "device": {// 告警类型名称
            "level": "1",  // 告警类型层级，可能为1或2
            "name": "设备", // 告警类型中文名称
            "id": "7", // 告警类型id
            "projectId": "0", // 所属项目id
            "english_name": "device", // 告警类型英文名称 
            "parentId": "0" // 告警类型所属的父类型id，如果为0说明是一级告警类型。或者通过没有 "."也能判断
        },
        "device.fault": { // 通过device.开头可以判断该二级告警类型所属的一级告警类型为device，也可以通过parentId判断
            "level": "2",
            "name": "故障",
            "id": "36",
            "projectId": "0",
            "english_name": "fault",
            "parentId": "7"
        }
    },
    "success": true
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

← 动态数据联动接口 →

# 数字空间告警接口

# 1. 获取告警列表

# 2. 处理告警记录

# 3. 根据类型级别状态统计告警信息

# 4. 根据告警类型状态起始时间统计告警信息

# 5. 根据告警类型状态起始时间 按照时间间隔统计告警信息

# 6. 批量获取告警图片信息

# 7. 批量添加告警处理记录

# 8. 根据wId和时间查询人流告警信息

# 9. 根据告警id查询告警处理记录

# 10. 获取收敛的告警列表

# 11. 通用告警统计接口

# 11.1. 当前项目所含告警类型接口

# 11.2. 当前项目所含告警子类型接口

# 11.3. 告警数据统计计数接口

# 12. 告警状态统计接口

# 13. 当前项目所有告警类型

# 5. 根据告警类型状态起始时间按照时间间隔统计告警信息