接口通用说明

OneAlert Restful API 基于HTTP JSON格式。

API域名地址

默认域名地址 c.onealert.com

创建告警域名地址 api.onealert.com

通信协议

HTTP或HTTPS,HTTPS即将开放。

参数形式

默认基于URL参数形式(encode),如果特殊指出,则基于body形式。

字符编码

请求及返回结果都使用UTF-8字符集进行编码。

公用输入参数

需认证的API使用到的参数

参数 类型 必须 备注
UPYOO_TOKEN string 必须 认证后的Token
curl -H "Content-type: application/json" -X GET \
"http://c.onealert.com/alert/api/alert?UPYOO_TOKEN=869ceb52-ef29-409c-980d-d0a48bc36bf2&status=ACTIVE"

公用返回参数

返回JSON数据

参数 类型 必须 备注
result string 必须 success/failed
message string 可选 如果失败,失败消息
code string 可选 正常200,或者其他错误码
totalCount int 可选 查询记录总数
data object 可选 业务数据,如果是对象,则是json object;如果是列表,则是json array。 业务API接口的返回参数是针对data说的。
{
    "result": "success",
    "message": null,
    "totalCount": 1,
    "code": "200",
    "data": [
        {
            "alarmId": 319,
            "alarmType": "EVENT",
            "alarmName": "FAILURE for production/HTTP on machine 192.168.0.253",
            "entityName": "host-192.168.0.253",
            "hostIp": null,
            "status": "CLOSED",
            "priority": 1,
            "alarmContent": "ping time:1500ms,load avg:0.75",
            "count": 3,
            "creationTime": "14-11-18 15:24",
            "modifiedTime": "14-11-18 15:30",
            "timeDuring": "6分",
            "closeTime": "14-11-18 15:30",
            "entityId": "host-192.168.0.253",
            "alarmDefId": null,
            "app": "d1337d7f-9be7-d55b-57a1-f787f5791e5d",
            "service": {
                "id": "10ae4d62-5a91-b204-a60e-8e09cbad9859",
                "escalationId": "7d67fd0a-1aed-c9de-5bb5-10ab4af74cd1",
                "entityId": "d1337d7f-9be7-d55b-57a1-f787f5791e5d",
                "description": "测试应用",
                "integrateType": "api",
                "autoResolve": 1800000,
                "ackTimeout": 0,
            },
            "assignments": [
                "helloworld"
            ]
        }
    ]
}

如果您对 OneAlert 感兴趣,可以选择使用我们的产品,只需要点击下面的按钮免费注册即可。


注册,永久免费使用 OneAlert