专有云计算 > API 文档 > 查询告警组集合

查询告警组集合

最近更新时间: 2022-01-18 12:16:14

请求路径

GET /api/rio/v1/compute/warn

请求参数

名称	类型	位置	必须	描述
x-rio-zone-id	string	header	是	地域 ID
name	string	query	否	告警组名称
marker	string	query	否	marker 分页参数
limit	string	query	否	marker 分页参数

返回值

名称	类型	描述
request_id	string	请求 ID
data	[]Warn	告警组
total	integer	数据总量

Warn 告警组详情

名称	类型	描述
name	string	名称
warn_id	string	ID
status	string	状态： `OK`：正常 `INSUFFICIENT_DATA`：数据不足 `ALARM`：告警中
alert_user	string	告警联系人
phone_list	[]string	电话号
email_list	[]string	邮箱
enable	string	启用状态： `1`：启用 `0`：禁用
rules	[]WarnRule	告警规则
instances	[]WarnInstance	告警实例

WarnRule 告警规则

名称	类型	描述
rule_type	string	指标： `CPUUtilization`：CPU使用率，单位：% `disk_readbytes`：磁盘每秒读取的字节数，单位：MB/s `disk_readiops`：磁盘每秒的读请求数量，单位：次/s `disk_writebytes`：磁盘每秒写入的字节数，单位：MB/s `disk_writeiops`：磁盘每秒的写请求数量，单位：次/s `diskusage_utilization`：磁盘使用率，单位：% `memory_usedutilization`：内存使用率，单位：% `networkin_errorpackages`：设备驱动器检测到的发送错误包的数量，单位：个/s `networkin_packages`：网卡每秒发送的数据包数，单位：个/s `networkin_rate`：网卡的上行带宽，单位：M/s `networkout_errorpackages`：设备驱动器检测到的接受错误包的数量，单位：个/s `networkout_rate`：网卡的下行带宽，单位：M/s `netin_dropped_packet_rate`：网络流入丢包率，单位：个/s `netout_dropped_packet_rate`：网络流出丢包率，单位：个/s `networkout_packages`：网络包流入速率，单位：个/s `diskio_read_delay`：磁盘IO读延迟，单位：ms `diskio_write_delay`：磁盘IO写延迟，单位：ms
rule_flag	string	告警开启状态： `1`：启用 `0`：禁用
medium_threshold	integer	中度阈值
seriousness_threshold	integer	严重阈值
time_interval	integer	时间间隔，单位：s，默认 60s
statistics	string	告警数据统计类型，默认`max`： `max`：最大值 `min`：最小值 `avg`：平均值
comparison_operator	string	比较规则，默认`>=`： `>`：大于 `>=`：大于等于 `!=`：不等于 `<`：小于 `<=`：小于等于

WarnInstance 告警实例

名称	类型	描述
instance_id	string	云主机 ID
instance_name	string	云主机 Name
instance_type	string	资源类型： `cloud`：云主机

请求值示例

返回值示例

{
    "request_id":"HtPfEjfvLBxTQMsW",
    "data":[
        {
            "name":"warn-c9rsP",
            "warn_id":"927e3fde-87d2-4f91-8e7e-6afe0b0abeb0",
            "status":"OK",
            "alert_user":"",
            "phone_list":[

            ],
            "email_list":[

            ],
            "enable":"1",
            "default_flag":"0",
            "rules":[
                {
                    "event_type":"networkin_packages",
                    "rule_flag":"0",
                    "medium_threshold":50000,
                    "seriousness_threshold":100000,
                    "time_interval":60,
                    "statistics":"max",
                    "comparison_operator":"\u003e="
                },
                {
                    "event_type":"networkout_packages",
                    "rule_flag":"0",
                    "medium_threshold":50000,
                    "seriousness_threshold":100000,
                    "time_interval":60,
                    "statistics":"max",
                    "comparison_operator":"\u003e="
                }
            ],
            "instances":[

            ]
        },
        {
            "name":"warn-Ico7m",
            "warn_id":"97bfb630-bd16-44f7-b709-2a5701e430a4",
            "status":"OK",
            "alert_user":"",
            "phone_list":[

            ],
            "email_list":[

            ],
            "enable":"1",
            "default_flag":"0",
            "rules":[
                {
                    "event_type":"disk_readbytes",
                    "rule_flag":"0",
                    "medium_threshold":500,
                    "seriousness_threshold":800,
                    "time_interval":60,
                    "statistics":"max",
                    "comparison_operator":"\u003e="
                },
                {
                    "event_type":"networkin_rate",
                    "rule_flag":"0",
                    "medium_threshold":500,
                    "seriousness_threshold":800,
                    "time_interval":60,
                    "statistics":"max",
                    "comparison_operator":"\u003e="
                }
            ],
            "instances":[

            ]
        }
    ],
    "Total":2
}

以上内容是否对您有帮助？