更新时间:2024-05-21 GMT+08:00
分享

批量获取智能告警图片下载路径

功能介绍

北向第三方服务调用,传入告警分类及告警ID数组生成图片下载路径列表

URI

POST /v1/{user_id}/alarms/pictures

表1 路径参数

参数

是否必选

参数类型

描述

user_id

String

用户ID:由数字组成,长度范围[15,25],获取方式参考获取user ID与下载AK/SK章节

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Access-Token

String

用户认证token,从获取用户认证token接口获取

表3 请求Body参数

参数

是否必选

参数类型

描述

alarm_classification

String

告警分类:

  • INTELLIGENT(移动智能告警,包括移动侦测和周界告警)
  • TARGET (目标智能告警)
  • TARGET_DET (口罩告警)
  • CROWD(人群态势告警)
  • THIRD_PARTY / THIRDPARTY_INTELLIGENT(第三方智能告警)

该字段已弃用,客户只需要传入正确的alarm_uuids即可

alarm_uuids

Array of strings

告警的alarm_uuid数组:alarm_uuid是告警信息的唯一标识,每条告警信息都拥有该属性,包含在消息管理配置的通知URL推送的告警消息体中,从设备智能告警消息中查阅,数组长度[1,100]

由产生该条告警的设备ID,通道ID,告警的消息类型和时间等信息组成。例如:2000000000WLL0000001_0_target_alarm_20060102150405_0

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述消息管理

failed_num

Integer

请求失败的错误数量

alarms

Array of AlarmPictureUrlsResAlarm objects

响应信息

表5 AlarmPictureUrlsResAlarm

参数

参数类型

描述

alarm_uuid

String

告警id

url

String

告警图片网络下载路径,该路径有效期为五分钟

targetgroup_url

String

目标组图片网络下载路径,该路径有效期为五分钟,如果没有该图片则返回空

result

AlarmPictureUrlReqResult object

响应信息

表6 AlarmPictureUrlReqResult

参数

参数类型

描述

code

String

错误码

msg

String

错误码描述

请求示例

接口请求示例

/v1/123456789*****/alarms/pictures

{
  "alarm_uuids" : [ "HOLOIPCALARM53200_0_people_count_line_alarm_20230220201831_17" ]
}

响应示例

状态码: 200

接口响应

{
	"failed_num": 0,
	"alarms": [
		{
			"alarm_uuid": "HOLOIPCALARM53200_0_people_count_line_alarm_20230220201831_17",
			"url": "http://123.123.123.123:31012/v1/holo/HOLOIPCALARM53200_0_people_count_line_alarm_20230220201831_17.jav?secret=lln7Rnpg6sS%2BvUp%2BD%2FPHKCpbsVhg&type=0&expire=1676926267&extend=0",
			"targetgroup_url": "",
			"result": {
				"code": "IVM.0",
				"msg": "success"
			}
		}
	]
}

状态码

请参见状态码

错误码

请参见错误码

相关文档