最近更新时间:2024.03.12 16:52:17
首次发布时间:2022.10.09 10:39:16
调用ListRulesByIds接口根据告警策略ID查询告警策略。
POST https://open.volcengineapi.com?Action=ListRulesByIds&Version=2018-01-01
ServiceName : Volc_Observe Region : cn-beijing AccessKey : xxx SecretKey : xxx
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Ids | Array | 是 |
| 要查询的告警策略ID。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Data | Array | - | 数组元素为告警策略内容。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Id | String |
| 告警策略ID。 |
RuleName | String |
| 告警策略名称。 |
Description | String |
| 策略描述。 |
Namespace | String |
| 此策略的监控指标所属的产品空间。参见云产品监控指标下各产品的Namespace。 |
SubNamespace | String |
| 此策略引用的指标所属的维度。参见云产品监控指标下各产品的SubNamespace。 |
CreatedAt | String |
| 告警策略创建时间。表达方式为时间戳。 |
UpdatedAt | String |
| 告警策略最后更新时间。表达方式为时间戳。 |
ContactGroupIds | Array |
| 告警策略绑定的告警通知组ID。 |
AlertMethods | Array |
| 告警策略的通知方式。
|
AlertState | String |
| 告警状态。
|
Level | String |
| 告警级别。
|
Conditions | Array | - | 告警条件。是一个数组,里面可填多个指标判断式,最多10个。元素内容,请参见Conditions数据结构。 |
OriginalDimensions | Map | - | 策略检测的资源ID。具体格式,请参见OriginalDimensions数据结构。 |
EffectStartAt | String |
| 策略生效窗口的开始时间。表达方式为HH:MM。 |
EffectEndAt | String |
| 策略生效窗口的截止时间。表达方式为HH:MM。 |
EnableState | String |
| 开启状态。
|
Regions | Array |
| 生效的RegionId列表。目前只能填一个RegionId。 |
EvaluationCount | Integer |
| 连续几次检测达到阈值才告警。 |
SilenceTime | Integer |
| 告警发送周期。单位为分钟。支持配置为5、30、60、180、360、720、1440。 |
MultipleConditions | Boolean |
| 告警策略是否用多指标。
|
ConditionOperator | String |
| 多指标判定条件。
|
RecoveryNotify | String | - | 告警恢复通知。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
MetricName | String |
| 监控指标的名称。参见云产品监控指标下各产品的MetricName。 |
MetricUnit | String |
| 监控指标的单位。参见云产品监控指标下各产品的MetricUnit。 |
Statistics | String |
| 统计方法。目前支持avg、max、min。 |
ComparisonOperator | String |
| 比较符号。支持 >、>=、<、<=、!=、=。 |
Threshold | String |
| 此指标的判断阈值。 |
Period | String |
| 统计周期。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Key | String |
| 指标的Dimensions名称,例如:ResourceID、NodeName等。 |
Value | Array |
| 指标的Dimension的值,是一个数组。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Enable | Boolean |
| 是否开启告警恢复通知。默认自动开启。 |
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 } } ] } }