基于多条件获取告警信息¶

该接口基于多条件组合进行告警信息查询最多31天历史告警信息。响应参数信息同获取告警数据(推荐使用)。

示例¶

请求URl（POST）

curl --location --request POST 'https://caweb.aiops.com/api/alert/rest/api/v1/alert/historymonth?appKey=XXXXXXXXXXXX&startTime=2024-12-31&endTime=2025-01-14' \
--user 'email@example.com:<access_token>' \
--header 'Content-Type: application/json' \
--data '{
    "conditions": 
    [
        {
            "field": "PRIORITY",
            "value": [4,5],
            "operator": "in"
        },
        {
            "field": "ALARM_CONTENT",
            "value": "123",
            "operator": "contain"
        }
    ],
    "relation": "or"
}'

请求地址参数说明¶

参数	类型	是否必须	说明
appKey	string	必须	应用ID
startTime	string	必须	开始时间示例：2022-6-6
endTime	string	必须	结束时间示例：2022-6-6

access_token如何获取请参考文档 api令牌

提示

• 示例邮箱应替换为用户注册所用邮箱

• access_token应替换为您手动获取的access_token

• 如需对请求进行加密处理：请将

--user 'email@example.com:access_token' \

--header 'Accept: application/json'

替换为：

--header 'Authorization: Basic Z2FveWluaW5nOTk5NUAxNjMuY29tOmt1WWl6bmljZ3oxN0JBVjk=' \

--header 'Content-Type: application/json'

• 替换步骤请参考加密步骤

请求报文data参数¶

字段名	类型	说明
conditions	Array	必填，一个条件数组，每个条件对象包含以下字段
relation	string	必填，条件之间的逻辑关系，可以是 and（且）或 or（或）

conditions中参数

字段名	类型	说明
field	string	必填，字段名例如 PRIORITY、ALARM_CONTENT
value	String or Array	必填，字段值可以是单个值或一个数组
operator	string	必填，操作符，例如 eq（等于）、gt（大于）、lt（小于）、ne（不等于）、contain（包含）、not_contain（不包含）、in（在列表中）、not_in（不在列表中）。

提示

• operator为在列表中和不在列表中 value需要为数组类型，如示例中的"field": "PRIORITY"对应的value值方式

field中字段名说明

字段名	说明
PRIORITY	告警级别
ALARM_NAME	告警标题
ALARM_CONTENT	告警内容
SOURCE	集成类型
HOST	主机
ENTITY_NAME	告警对象
ID	告警ID
UPDATE_TIME	更新时间
SERVICE	服务

响应报文¶

{
    "result":"success",
    "message":null,
    "data":{
        "alarms":[
            {
                "APP":"c620c3c73XXXXX54809179627881dc23",
                "ID": 74507500,
                "CLOSE_COMMENTS":"超时自动关闭",
                "DETAILS":"",
                "APPLICATION":"",
                "ACK_TIME":null,
                "ALARM_CONTENT":"CNBE44-F06-M-7205-WAC02CNBE44-F06-M-AP02-59DC",
                "PRIORITY":3,
                "ACK_USER":null,
                "ACK_USER_NAME": "睿小象",
                "UPDATE_TIME":1635302970506,
                "CONTEXTS":"",
                "STATUS":"CLOSED",
                "HOST":null,
                "SOURCE":"zabbix",
                "CLOSE_TIME":1635304200040,
                "SERVICE":"CNBE44-F06-M-AP02-59DC:Channel Busy Rate",
                "CREATE_TIME":1635302968395,
                "CLOSE_USER":"System",
                "ALARM_NAME":"High Channel Utilization 123"，
                "TAG": "",
                "LABELS": [
                {
                    "name": "账号ID",
                    "value": "",
                    "key": "$['Message']['account']"
                },
                {
                    "name": "通知类型",
                    "value": "",
                    "key": "$['Message']['detail-type']"
                },
                {
                    "name": "案例 ID",
                    "value": "",
                    "key": "$['Message']['detail']['display-id']"
                },
                {
                    "name": "变更类型",
                    "value": "",
                    "key": "$['Message']['detail']['event-name']"
                }
            ],
            "ENTITY_NAME": "手动触发",
            "jira": "false"
            }
        ]
    },
    "totalCount":77,
    "code":200
}

响应参数

参数	类型	说明
result	string	返回结果：success成功、false 失败
message	string	返回消息
data		返回数据集
totalCount	int	数据量
code	int	响应码

data结果集

参数	类型	说明
ALARM_NAME	string	告警标题
STATUS	string	告警状态（ACTIVE 待处理/CLOSED 关闭/ACK认领）
PRIORITY	int	告警级别(1提醒/2警告/3严重)
ALARM_CONTENT	string	告警内容
CREATE_TIME	long	告警创建时间
UPDATE_TIME	long	告警更新时间
CLOSE_TIME	long	告警关闭时间
SOURCE	string	告警来源
APP	string	应用ID
ACK_TIME	long	认领时间
ACK_USER	string	认领人ID
CLOSE_USER	string	关闭人ID
CLOSE_COMMENTS	string	关闭注释
HOST	string	主机
SERVICE	string	服务
APPLICATION	string	应用
DETAILS	string	详情
ID	int	告警编号
ACK_USER_NAME	string	认领人名称
TAG	string	自定义标签
LABELS	对象数组	针对prometheus自定义labels的内容
ENTITY_NAME	string	告警对象
jira	string	是否提交了JIRA（false 否；true 是）

错误响应¶

{ 
    "result": "failed", 
    "message": "error", 
    "data": "失败，请检查请求参数,null", 
    "totalCount": 0, 
    "code": 400 
}

错误响应码

错误码	说明
200	成功
400	失败，传入的参数有问题
401	认证失败，用户名密码错误
403	权限失败，用户没有权限做此操作