ThingsKit物联网平台API文档-监控运维(告警管理-告警记录)

分页记录(告警列表查询)

接口地址:/api/yt/alarm{?endTime,fetchOriginator,page,pageSize,searchStatus,sortOrder,sortProperty,startTime,status,textSearch}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

请求参数:

参数名称参数说明数据类型
pagepageint
pageSizepageSizeint
status告警/确认状态AlarmStatus
alarmType告警场景String
deviceName告警设备String
severity告警级别AlarmSeverity
startTime开始时间Long
endTime结束时间Long
deviceId设备idString
deviceType设备类型deviceTypeEnum

响应参数:

参数名称参数说明类型
id主键idstring
ackTs处理时间int
acknowledged处理状态boolean
clearTs清除时间int
cleared清除状态boolean
createdTime创建时间int
creator创建人string
customerId客户idstring
details告警详情json
deviceAlias告警设备别名string
deviceId告警设备idstring
deviceName告警设备名称string
endTs告警结束时间int
organizationId组织idstring
organizationName组织名称string
originatorTypestring
propagate传递标识string
propagateRelationTypes传递类型string
severitystring
startTs告警开始时间int
tbDeviceIdtb设备idstring
tenantId租户idstring
type告警场景string
updatedTime修改时间int
updater修改人string

响应示例:

{
    "total": 1,
    "items": [
        {
            "id": "f6ae90e6-78c6-47f0-95c0-fc7fefc9c52c",
            "tenantId": "01482120-5ddb-11ef-b746-1f75222e5f46",
            "creator": null,
            "updater": null,
            "createdTime": "2024-08-21 14:56:11",
            "updatedTime": "1970-01-01 08:00:00",
            "customerId": "72f7a060-5df0-11ef-b746-1f75222e5f46",
            "tbDeviceId": "fb665df0-5e96-11ef-81b9-2ff152897d7a",
            "originatorType": 5,
            "deviceId": "fb665df0-5e96-11ef-81b9-2ff152897d7a",
            "deviceName": "9G9ssfLm5U1ZX2r9",
            "type": "测试告警",
            "severity": "WARNING",
            "acknowledged": false,
            "cleared": false,
            "startTs": "2024-08-21 14:56:11",
            "endTs": "2024-08-21 14:56:11",
            "ackTs": "1970-01-01 08:00:00",
            "clearTs": "1970-01-01 08:00:00",
            "details": {
                "fb665df0-5e96-11ef-81b9-2ff152897d7a": {//告警详情id
                    "triggerData": {//告警信息json
                        "key": "CurrentTemperature",//触发属性
                        "realValue": 50,//触发值
                        "logicValue": 20,//触发条件值
                        "logic": "GREATER"//触发条件
                    }
                }
            },
            "propagate": false,
            "propagateRelationTypes": "",
            "organizationId": "f85dab7d-69e3-424d-89d3-8ed5f45ab396",
            "organizationName": "默认",
            "deviceAlias": "测试设备"
        }
    ]
}

清除告警

接口地址:/api/alarm/{alarmId}/clear

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:`/

请求参数:

参数名称参数说明请求类型是否必须数据类型
alarmId分页列表返回的主键idpathtruestring

处理告警

接口地址:/api/alarm/{alarmId}/ack

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

请求参数:

参数名称参数说明请求类型是否必须数据类型
alarmId分页列表返回的主键idpathtruestring