备案 控制台 登录 注册
文档中心 > openListAlarmRecored
openListAlarmRecored

最近更新时间：2022-11-11

请求方法：GET

接口描述：查询告警记录。

请求参数

名称

数据类型

参数类型

是否必填

描述

Authorization

String

Header

Y

签名信息

Content-Type

String

Header

Y

application/json; charset=utf-8

X-UNI-Timestamp

String

Header

Y

工具类生成的时间戳

Host

String

Header

Y

紫光云openapi host地址

Action

String

Query

Y

openListAlarmRecord

ruleType

String

Query

Y

告警类型（monitor-云资源告警，event-事件告警）

instanceId

String

Query

N

实例ID查询

regionId

String

Query

Y

节点（地域）ID

startTime

Long

Query

Y

开始时间（毫秒级时间戳）

endTime

Long

Query

Y

结束时间（毫秒级时间戳）

page

Integer

Query

Y

页数

Size

Integer

Query

Y

页码

Status

String

Query

N

状态：

  • warning-告警中

  • recovery-已恢复

  • datadeficient-数据不足

  • failure-已失效

事件告警记录只有一个状态-已触发

level

array

Query

N

告警级别：

  • EMERGENCY-紧急

  • IMPORTANT-重要

  • ORDINARY-次要

  • INFORMATION-提示

查询多个时用逗号（英文）分割

如：EMERGENCY,ORDINARY

ruleName

String

Query

N

规则名称

AccessKeyId

String

Query

Y

Ak

返回参数

名称

类型

描述

auth

Boolean


code

String

接口调用返回码

msg

String

接口调用信息

data

Object


res

Object

返回数据

res

page

Integer

当前页数

size

Integer

当前页码

totalCount

Integer

数据总量

totalPages

Integer

总页数

list

Array

返回数据

List

userId

String

用户ID

regionId

String

节点ID

alarmRuleId

String

规则ID

alarmRuleType

String

告警类型

alarmRuleName

String

规则名称

alarmJobType

String

资源类型

alarmJobTypeName

String

资源名称

alarmRuleDesc

String

规则描述

startAt

Long

告警开始时间

alarmRuleLevel

String

告警级别

status

String

状态

objectId

String

故障资源

错误码

公共错误参见“公共错误码集合”。

示例

请求示例

http://10.0.45.193:30990/openMonitor?Action=openListAlarmRecord&regionId=cn-tianjin-yfb&ruleType=monitor&startTime=1662188385521&endTime=1662447585521&page=1&size=10&AccessKeyId=yaJisjJkIkTeTEue

Hearder

Authorization：UNI3-HMAC-SHA256 Credential=AfAgoRP69cLbqnbO/2022-09-15/openMonitor/uni3_request, SignedHeaders=content-type;host;x-uni-timestamp, Signature=649c42b642c08bd9751a7e29f89e906bf978f721799bf5ee2bfd2fab76057d4e

Content-Type：application/json; charset=utf-8

X-UNI-Timestamp：1663211428

Host：10.0.45.193:30990

返回实例

JSON格式

{

    "status": true,

    "code": "0",

    "res": {

        "page": 1,

        "size": 10,

        "totalCount": 3,

        "totalPages": 1,

        "list": [

            {

                "id": 10000076,

                "userId": "18f48407-e9ce-4e01-b42e-3d4bd1f26eb1",

                "regionId": "cn-tianjin-yfb",

                "alarmRuleId": "ar-ggzycagv5hzw",

                "alarmRuleType": "monitor",

                "alarmRuleName": "mq-节点",

                "alarmJobType": "RABBITMQ",

                "alarmJobTypeName": "消息队列RabbitMQ",

                "alarmRuleDesc": "网络流入速率平均值于5分钟监控周期内>= 0.0KB/s ,且连续1次则每5分钟通知一次",

                "startAt": 1661226258025,

                "alarmTime": 1663211358000,

                "alarmRuleLevel": "EMERGENCY",

                "informResult": 0,

                "status": "DATADEFICIENT",

                "convergenceTimes": 3388,

                "tags": "{\"instance\":\"rabbitmq-udp46ygnyzgg\",\"nodeId\":\"rabbitmq-udp46ygnyzgg_DISK_3\"}",

                "objectId": "rabbitmq-udp46ygnyzgg_DISK_3"

            }

        ],

        "records": []

    },

    "msg": null,

    "auth": true

}