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

ListRulesByIds

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

首次发布时间2022.10.09 10:39:16

调用ListRulesByIds接口根据告警策略ID查询告警策略。

Request URL

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

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

请求参数

参数

类型

是否必填

示例值

描述

Ids

Array

["1502121719593******"]

要查询的告警策略ID。

返回数据

参数

类型

示例值

描述

Data

Array of Struct

-

数组元素为告警策略内容。

Data数据结构

参数

类型

示例值

描述

Id

String

1502121719593******

告警策略ID。

RuleName

String

vketest

告警策略名称。

Description

String

测试告警

策略描述。

Namespace

String

VCM_VKE

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

SubNamespace

String

Cluster

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

CreatedAt

String

1659421463

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

UpdatedAt

String

1659529768

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

ContactGroupIds

Array of String

["148357472501******"]

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

AlertMethods

Array of String

["Email"]

告警策略的通知方式。

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

AlertState

String

normal

告警状态。

  • alerting:告警中
  • normal:正常

Level

String

critical

告警级别。

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

Conditions

Array

-

告警条件。是一个数组,里面可填多个指标判断式,最多10个。元素内容,请参见Conditions数据结构

OriginalDimensions

Map

-

策略检测的资源ID。
具体格式,请参见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

&&

多指标判定条件。

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

RecoveryNotify

String

-

告警恢复通知。
详情请参见RecoveryNotify数据结构

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的值,是一个数组。
如果希望选择"全部"实例的值,可以填星号 "*"。例如:["*"]。

RecoveryNotify数据结构

参数

类型

示例值

描述

Enable

Boolean

true

是否开启告警恢复通知。默认自动开启。

请求示例

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

{
    "Ids":[
        "1502121719593******"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023****54A0",
        "Action": "ListRulesByIds",
        "Version": "2018-01-01",
        "Service": "",
        "Region": ""
    },
    "Result": {
        "Data": [
            {
                "Namespace": "VCM_VKE",
                "ResourceType": "容器服务",
                "SubNamespace": "Cluster",
                "Dimension": "集群",
                "Id": "150****752",
                "CreatedAt": "1659421463",
                "UpdatedAt": "1659529768",
                "Regions": [
                    "cn-beijing"
                ],
                "AccountId": "2000******",
                "RuleName": "vketest",
                "RuleType": "static",
                "Level": "critical",
                "EnableState": "enable",
                "ContactGroupIds": [
                    "148357472501******"
                ],
                "AlertMethods": [
                    "Email"
                ],
                "CheckInterval": 1,
                "EvaluationCount": 5,
                "SilenceTime": 5,
                "EffectStartAt": "00:00",
                "EffectEndAt": "23:59",
                "Dimensions": [
                    {
                        "Cluster": "*"
                    }
                ],
                "OriginalDimensions": null,
                "Conditions": [
                    {
                        "MetricName": "Cluster_CPUUsed",
                        "MetricUnit": "Core",
                        "Period": "",
                        "Statistics": "avg",
                        "ComparisonOperator": ">",
                        "Threshold": "4"
                    },
                    {
                        "MetricName": "Cluster_MemoryUsed",
                        "MetricUnit": "Megabytes",
                        "Period": "",
                        "Statistics": "avg",
                        "ComparisonOperator": ">",
                        "Threshold": "3"
                    }
                ],
                "TriggerCondition": "多指标告警(任意):\n集群 CPU 用量平均值>4Core, 持续1个周期(1周期=1分钟)\n集群内存用量平均值>3MB, 持续1个周期(1周期=1分钟)",
                "AlertState": "normal",
                "Resources": {
                    "集群": [
                        "全部集群"
                    ]
                },
                "ConditionOperator": "||",
                "MultipleConditions": true,
                "RecoveryNotify":{
                    "Enable": true
                }
            }
        ]
    }
}