You need to enable JavaScript to run this app.
导航

ListRules

最近更新时间2024.02.02 18:41:09

首次发布时间2022.10.10 15:05:58

调用ListRules接口根据指定条件查询告警策略,请求参数中的条件是且的关系。

Request URL

POST https://open.volcengineapi.com?Action=ListRules&Version=2018-01-01

ServiceName : Volc_Observe
Region : cn-beijing 
AccessKey : xxx
SecretKey : xxx

请求参数

参数

类型

是否必填

示例值

描述

RuleName

String

test

查询指定的告警策略名称,会根据此告警名称做模糊匹配。

AlertState

Array

["normal"]

查询指定告警状态的告警策略,可以多选。
多个参数之间用半角逗号(,)间隔,例如:["normal","alerting"]。

  • alerting:告警中
  • normal:正常

Namespace

Array

["VCM_ECS"]

此策略的监控指标所属的产品空间。参见云产品监控指标下各产品的Namespace
可以多选。多个参数之间用半角逗号(,)间隔,例如:["VCM_ECS","VCM_VKE"]。

Level

Array

["critical"]

查询指定级别的告警策略,可以多选。
多个参数之间用半角逗号(,)间隔,例如:["critical","warning"]。

  • critical:严重
  • warning:警告
  • notice:通知

EnableState

Array

["enable"]

查询指定状态的告警策略,可以多选。
多个参数之间用半角逗号(,)间隔,例如:["enable","disable"]。

  • enable:开启
  • disable:停用

PageSize

Integer

10

分页使用。分页返回的每页数量。

PageNumber

Integer

1

分页使用。第几页,从第1页开始。

返回数据

参数

类型

示例值

描述

Data

Array

-

内容为数组,数组元素为告警策略内容。元素内容,请参见Data数据结构

PageNumber

Struct

1

分页使用,表示第几页,从第1页开始。

PageSize

Integer

10

分页使用,分页返回的每页数量。

TotalCount

Integer

20

符合条件的告警策略数量。

Data数据结构

参数

类型

示例值

描述

Id

String

157241625255******

告警策略ID。

RuleName

String

test

告警策略名称。

Description

String

测试告警

策略描述。

Namespace

String

VCM_ECS

此策略的监控指标所属的产品空间。参见云产品监控指标下各产品的Namespace

SubNamespace

String

Instance

此策略引用的指标所属的维度。参见云产品监控指标下各产品的SubNamespace

CreatedAt

String

1623292695

告警策略创建时间。表达方式为时间戳。

UpdatedAt

String

1624006117

告警策略最后更新时间。表达方式为时间戳。

ContactGroupIds

Array of String

["1562776379697******"]

告警策略绑定的告警通知组ID。

AlertMethods

Array of String

["Email"]

告警策略的通知方式。

  • Email:邮件
  • Phone:电话
  • SMS:短信
  • Webhook:告警回调

WebHook

String

http://alert.volc.com/callback

绑定的告警回调URL地址。

AlertState

String

normal

告警状态。

  • alerting:告警中
  • normal:正常

Level

String

critical

告警级别。

  • critical:严重
  • warning:警告
  • notice:通知

Conditions

Array

-

告警条件。
是一个数组,里面为指标判断式。具体格式,请参见Conditions数据结构

OriginalDimensions

Object

-

策略检测的资源ID。
是Map结构,具体格式,请参见OriginalDimensions数据结构

EffectStartAt

String

00:00

策略生效窗口的开始时间。表达方式为HH:MM。

EffectEndAt

String

23:59

策略生效窗口的截止时间。表达方式为HH:MM。

EnableState

String

enable

开启状态。

  • enable:开启
  • disable:停用

Regions

Array

["cn-beijing"]

生效的RegionId列表。目前只能填一个RegionId。

EvaluationCount

Integer

5

连续几次检测达到阈值才告警。

SilenceTime

Integer

5

告警发送周期。单位为分钟。

  • 5
  • 30
  • 60
  • 180
  • 360
  • 720
  • 1440

MultipleConditions

Bool

false

告警策略是否用多指标。

  • true:多指标
  • false:单指标(默认)

ConditionOperator

String

&&

多指标判定条件。

  • &&:多个指标同时成立才判定为触发告警
  • ||:任意指标满足条件触发判定为告警

Conditions数据结构

参数

类型

示例值

描述

MetricName

String

StorageUtil

监控指标的名称。参见云产品监控指标下各产品的MetricName

MetricUnit

String

Percent

监控指标的单位。参见云产品监控指标下各产品的MetricUnit

Statistics

String

avg

统计方法。目前支持avgmaxmin
统计方法是会应用到检测时间段内的数据上。比如默认是每次检测数据的时间跨度是1分钟,如果统计方法为avg,那就是对1分钟内的数据做avg。

ComparisonOperator

String

!=

比较符号。支持 >>=<<=!==

Threshold

String

100

此指标的判断阈值。

Period

String

60

统计周期。

OriginalDimensions数据结构

参数

类型

是否必填

示例值

描述

Key

String

ResourceID

指标的Dimensions名称,例如:ResourceID、NodeName等。

Value

Array

["i-ybw74rtkvd9z6f******",
"i-ybvwojvnep9z6g******"]

指标的Dimension的值,是一个数组。
如果希望选择"全部"实例的值,可以填星号 "*"。例如:["*"]。

请求示例

POST https://open.volcengineapi.com?Action=ListRules&Version=2018-01-01
ServiceName=Volc_Observe
Region=cn-beijing 
AccessKey=xxx 
SecretKey=xxx 

{
    "RuleName": "testabc",
    "AlertState": [
        "normal"
    ],
    "Namespace": [
        "VCM_ECS"
    ],
    "Level": [
        "critical",
        "warning"
    ],
    "EnableState": [
        "enable"
    ],
    "PageSize": 10,
    "PageNumber": 1
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202209211700000102120522060*******",
        "Action": "ListRules",
        "Version": "2018-01-01",
        "Service": "",
        "Region": ""
    },
    "Result": {
        "Data": [
            {
                "Namespace": "VCM_ECS",
                "ResourceType": "云服务器",
                "SubNamespace": "Instance",
                "Dimension": "实例",
                "Id": "157241625255*******",
                "CreatedAt": "1663728223",
                "UpdatedAt": "1663748593",
                "Regions": [
                    "cn-beijing"
                ],
                "AccountId": "2100******",
                "RuleName": "test",
                "RuleType": "static",
                "Level": "warning",
                "EnableState": "disable",
                "ContactGroupIds": [
                    "1562776379697******"
                ],
                "AlertMethods": [
                    "Webhook",
                    "Email"
                ],
                "WebHook": "",
                "Description": "",
                "CheckInterval": 1,
                "EvaluationCount": 1,
                "SilenceTime": 5,
                "EffectStartAt": "00:00",
                "EffectEndAt": "23:59",
                "Dimensions": [
                    {
                        "ResourceID": "*"
                    }
                ],
                "OriginalDimensions": {
                    "ResourceID": [
                        "*"
                    ]
                },
                "Conditions": [
                    {
                        "MetricName": "Instance_CpuBusy",
                        "MetricUnit": "Percent",
                        "Statistics": "avg",
                        "ComparisonOperator": "<=",
                        "Threshold": "100",
                        "Period": "60"
                    }
                ],
                "TriggerCondition": "多指标告警(任意):\n带外CPU利用率平均值<=100%, 持续1个周期(1周期=1分钟)\n带外磁盘读带宽平均值<=999MiB/s, 持续1个周期(1周期=1分钟)\n带外磁盘写带宽平均值<=999MiB/s, 持续1个周期(1周期=1分钟)",
                "AlertState": "normal",
                "ConditionOperator": "||",
                "MultipleConditions": true,
                "AlarmTemplateId": "",
                "AlarmTemplateType": ""
            }
        ],
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 1,
        "OrderBy": "",
        "Asc": false
    }
}