新增触发器
请求方式:POST
URL: http(s)://api.heclouds.com/triggers
我只想看示例!!!
http请求参数
参数名称 | 格式 | 是否必须 | 说明 |
title | string | 是 | 触发器名称 |
ds_id | string | 否 | 可选,数据流名称,数据流名称,由{obj_id}_{obj_inst_id}_{res_id}组成 |
dev_ids | array-string | 否 | 可选,设备ID |
ds_uuids | array-string | 否 | 可选,数据流uuid |
url | string | 是 | 告警通知地址 |
type | string | 是 | 触发条件,见type说明列表 |
threshold | | 是 | 触发条件门限值,与type配合使用,见type说明列表 |
参数说明
1、触发器的含义是:当指定范围内的数据点满足触发条件的要求时,会向url参数指定的地址发送post请求;
2、触发器有三种工作触发模式
1) 在请求参数中单独指定了ds_id,不包括其他参数,那么当前项目下所有设备的数据流中数据流名称符合ds_id的
数据都会进入触发判断逻辑;
2) 在请求参数中单独指定了ds_uuids数组,那么只有这些指定的数据流会进入触发判断逻辑;
3) 在请求参数中指定了ds_id和dev_ids,那么只有这些指定的设备的数据流会进入触发判断逻辑。
type说明列表
type | 说明 |
> | threshold必须为数值 |
< | threshold必须为数值 |
>= | threshold必须为数值 |
<=< td=""> | threshold必须为数值 | =<>
inout | threshold设置为{"lolmt":40,"uplmt":52},表示数据值进入或离开闭区间[40,52]时触发 |
change | threshold参数不用传递;当上传的值有改变时触发告警 |
frozen | threshold为数值,指定多少秒内未上报数据触发告警,同时被监控对象进入frozen状态 |
live | threshold为数值,指定多少秒后上报数据触发告警 |
返回参数
参数名称 | 格式 | 说明 |
errno | int | 调用错误码,为0表示调用成功 |
error | string | 错误描述,为"succ"表示调用成功 |
data | json | 接口调用成功之后返回的设备相关信息,见data描述表 |
data描述表
参数名称 | 格式 | 说明 |
trigger_id | int | 触发器ID |
请求头部示例
POST http://api.heclouds.com/triggers HTTP/1.1
api-key: YHC**************VqKA=
请求参数示例
{
"title": "trigger",
"ds_id": "gps",
"url": "http://aoic.choqf.com",
"type": ">",
"threshold": 100
}
返回示例
{
"errno":0,
"data": {
"trigger_id":123809
},
"error":"succ"
}
触发数据示例
{
"trigger": {
"id": 123809,
"threshold": 9.0,
"type": ">"
},
"current_data": [{
"dev_id": "2656",
"ds_id": "gps",
"ds_uuid": "FWEF-ZFW-ZFW-ZFWW",
"at": "2009-09-07T12:16:02.001403Z",
"value": 100
}
]
}