告警事件查询 - 混合云OpenAPI4.0

告警事件查询，混合云项目内定制接口。

请求参数

Query 参数

regionID

string

资源池ID

必需

pageNo

integer

查询页码，默认1

可选

pageSize

integer

可选

每页记录数目，取值范围:[1~10000]，默认值:10，单页最大记录不超过10000

alarmId

string

告警事件id

可选

from

number

可选

告警起始时间(毫秒级时间戳) from和to必须同时使用

number

可选

告警截至时间(毫秒级时间戳) from和to必须同时使用

alarmLevel

string

可选

告警级别（枚举值含义：2warning-提示告警，3average-一般告警，4high-严重告警，5disaster-紧急告警）

ruleName

string

可选

规则名称模糊查询不支持批量模糊查询由于网关解析问题请避免输入带有“%”

alarmObjId

string

告警对象id

可选

ruleId

string

告警规则id

可选

objType

string

可选

告警对象类型(宿主机:ph/云主机:vm/弹性IP:eip/弹性伸缩组:scaling/裸金属:bare_metal)，不做强制性校验以防底层/未来增加类型，输入有误则查询不到

history

integer

可选

仅展示历史数据(是：1；否：不传)，进行确认和清除之后的告警事件在此显示

current

integer

可选

仅展示当前数据(是：1；否：不传)，没进行确认清除操作的告警事件在此显示

shield

integer

可选

仅展示被屏蔽告警数据(是：1；否：不传)，根据屏蔽规则进行判断

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200successful operation

application/json

Body

description

string

失败时的错误描述

可选

errorCode

string

具体错误码标志

可选

message

string

失败时的错误信息

可选

statusCode

integer <int32>

可选

返回状态码(800为成功，900为失败)

returnObj

object

必需

currentCount

integer

当前条数

可选

totalCount

integer

总记录数

可选

totalPage

integer

总页数

可选

alarmEventList

array [object {15}]

告警事件查询列表

必需

示例

{
    "description": "成功",
    "errorCode": "SUCCESS",
    "message": "success",
    "returnObj": {
        "totalPage": 1,
        "currentCount": 5,
        "totalCount": 5,
        "alarmEventList": [
            {
                "alarmCount": 1,
                "alarmLevel": "3average",
                "alarmTime": "2023-11-06 09:16:59",
                "displayStatus": 0,
                "id": "65483e8bf2faca45a5b16379",
                "notifyInfo": {
                    "alarmGroupName": [
                        "唐人"
                    ],
                    "notifyType": "email",
                    "ruleUuid": "653f6032f2faca3832c4f8aa",
                    "userId": "1",
                    "userName": "超级管理员1"
                },
                "objId": "1d70e64f-e62c-ca50-8bdc-3d4f81905b25",
                "objName": "ecm-ybww4f",
                "objType": "vm",
                "region": 3,
                "regionName": "内蒙08",
                "ruleEnabled": true,
                "ruleId": "653f6032f2faca3832c4f8aa",
                "ruleName": "test-1030按uuid收敛-vm",
                "shield": 0
            },
            {
                "alarmCount": 1,
                "alarmLevel": "3average",
                "alarmTime": "2023-11-06 09:16:50",
                "displayStatus": 0,
                "id": "65483e82f2faca45a5b16346",
                "notifyInfo": {
                    "alarmGroupName": [
                        "唐人"
                    ],
                    "notifyType": "email",
                    "ruleUuid": "653f4fc2f2faca3832c4f8a8",
                    "userId": "1",
                    "userName": "超级管理员1"
                },
                "objId": "cn-nm-region1-az2-compute-10e8e92e24,cn-nm-region1-az2-compute-10e8e92e47",
                "objName": "cn-nm-region1-az2-compute-10e8e92e24,cn-nm-region1-az2-compute-10e8e92e47",
                "objType": "ph",
                "region": 3,
                "regionName": "内蒙08",
                "ruleEnabled": true,
                "ruleId": "653f4fc2f2faca3832c4f8a8",
                "ruleName": "test-1030按uuid收敛",
                "shield": 0
            },
            {
                "alarmCount": 2,
                "alarmLevel": "3average",
                "alarmTime": "2023-11-05 08:55:48",
                "displayStatus": 2,
                "id": "653f4fcff2faca38515b198f",
                "notifyInfo": {
                    "alarmGroupName": [
                        "唐人"
                    ],
                    "notifyType": "email",
                    "ruleUuid": "653f4fc2f2faca3832c4f8a8",
                    "userId": "1",
                    "userName": "超级管理员1"
                },
                "objId": "cn-nm-region1-az2-compute-10e8e92e24,cn-nm-region1-az2-compute-10e8e92e47",
                "objName": "cn-nm-region1-az2-compute-10e8e92e24,cn-nm-region1-az2-compute-10e8e92e47",
                "objType": "ph",
                "region": 3,
                "regionName": "内蒙08",
                "ruleEnabled": true,
                "ruleId": "653f4fc2f2faca3832c4f8a8",
                "ruleName": "test-1030按uuid收敛",
                "shield": 0
            },
            {
                "alarmCount": 2,
                "alarmLevel": "3average",
                "alarmTime": "2023-11-05 08:55:47",
                "displayStatus": 2,
                "id": "653f603af2faca38515b19ed",
                "notifyInfo": {
                    "alarmGroupName": [
                        "唐人"
                    ],
                    "notifyType": "email",
                    "ruleUuid": "653f6032f2faca3832c4f8aa",
                    "userId": "1",
                    "userName": "超级管理员1"
                },
                "objId": "3c907bd9-7333-6dfe-c0d4-4d7c1bd17e0e,1d70e64f-e62c-ca50-8bdc-3d4f81905b25",
                "objName": "ecm-altre1,ecm-ybww4f",
                "objType": "vm",
                "region": 3,
                "regionName": "内蒙08",
                "ruleEnabled": true,
                "ruleId": "653f6032f2faca3832c4f8aa",
                "ruleName": "test-1030按uuid收敛-vm",
                "shield": 0
            },
            {
                "alarmCount": 1,
                "alarmLevel": "3average",
                "alarmTime": "2023-10-30 10:44:43",
                "displayStatus": 2,
                "id": "653f189bf2faca38515b1858",
                "notifyInfo": {
                    "alarmGroupName": [
                        "default"
                    ],
                    "notifyType": "default",
                    "ruleUuid": "653f1893f2faca3832c4f82d",
                    "userId": "1",
                    "userName": "SuperAdmin"
                },
                "objId": "cn-nm-region1-az2-compute-10e8e92e24,cn-nm-region1-az2-compute-10e8e92e47",
                "objName": "cn-nm-region1-az2-compute-10e8e92e24,cn-nm-region1-az2-compute-10e8e92e47",
                "objType": "ph",
                "region": 3,
                "regionName": "内蒙08",
                "ruleEnabled": true,
                "ruleId": "653f1893f2faca3832c4f82d",
                "ruleName": "test-1030",
                "shield": 0
            }
        ]
    },
    "statusCode": 800
}