查询告警模板列表 - ListAlarmRuleTemplate

project_id

是

String

项目ID，可以从控制台获取，也可以从调用API处获取。获取方式请参见：获取项目ID。

id

否

String

告警模板id。

type

否

String

告警模板类型。

• 当type的值为“promql”时 返回CCE默认模板。

• 当type为其他值或不填时，返回全量模板。

X-Auth-Token

是

String

从IAM服务获取的用户Token。获取方式请参见：获取Token。

Content-Type

否

String

消息体的类型（格式）。指定类型为“application/json”。

Enterprise-Project-Id

否

String

企业项目id。获取方式请参见：获取企业项目ID。

• 查询单个企业项目下实例，填写企业项目id。

• 查询所有企业项目下实例，填写“all_granted_eps”。

alarm_rule_templates

Array of AlarmRuleTemplateBody objects

告警模板列表。

count

Integer

告警模板总数。

alarm_rule_template_name

String

告警模板名称。

alarm_rule_template_name_en

String

告警模板英文名称。

alarm_rule_template_description

String

告警模板描述。

alarm_rule_template_id

String

告警模板id。

alarm_rule_template_project_id

String

项目ID，可以从控制台获取，也可以从调用API处获取。获取方式请参见：获取项目ID。

alarm_rule_template_type

String

告警模板类型

• “statics”：静态告警模板

• “dynamic”：动态告警模板

alarm_rule_template_source

String

告警模板来源。

alarm_rule_template_binding

Map<String,String>

告警模板所绑定的告警规则。

alarm_template_spec_list

Array of AlarmRuleTemplateSpecWithCloudService objects

告警模板列表。

enterprise_project_id

String

企业项目id。获取方式请参见：获取企业项目ID。

create_time

Long

创建时间。

modify_time

Long

更新时间。

templating

Templating object

告警模板变量列表。

template_version

String

告警模板版本。

related_cloud_service

String

关联的云服务。

related_cce_clusters

Array of strings

关联的CCE集群。

related_prometheus_instances

Array of strings

关联的Prom实例。

alarm_notification

AlarmNotification object

通知信息。

alarm_template_spec_items

Array of AlarmTemplateSpecItem objects

告警模板列表。

notification_type

String

通知类型。

• “direct”：直接告警

• “alarm_policy”：告警降噪

枚举值：

• direct

• alarm_policy

route_group_enable

Boolean

启用告警分组规则。

• 当通知类型为“alarm_policy”时：true

• 当通知类型为“direct”时：false

如果告警触发“notify_triggered”或告警恢复“notify_resolved”都设置为false（即都不进行告警通知），则route_group_enable需设置为false。

枚举值：

• true

• false

route_group_rule

String

告警分组规则名称。

• 当route_group_enable 为true时，填告警分组规则名称

• 当route_group_enable 为false时，填“”

notification_enable

Boolean

是否启用告警通知规则。

• 当通知类型为“direct”时，填true

• 当通知类型为“alarm_policy”时，填false

如果告警触发“notify_triggered”或告警恢复“notify_resolved”都设置为false（即都不进行告警通知），则notification_enable需设置为false。

bind_notification_rule_id

String

告警行动策略id。

• 当notification_enable为true时，填告警行动策略id

• 当notification_enable为false时，填“”

notify_resolved

Boolean

告警解决是否通知。

• true：通知

• false：不通知

枚举值：

• true

• false

notify_triggered

Boolean

告警触发是否通知。

• true：通知

• false：不通知

枚举值：

• true

• false

notify_frequency

Integer

通知频率

• 当通知类型为“alarm_policy”时，填“-1”

• 当通知类型为“direct”时，

  • “0”：只告警一次

  • “300”：每5分钟

  • “600”：每10分钟

  • “900”：每15分钟

  • “1800”：每30分钟

  • “3600”：每1小时

  • “10800”：每3小时

  • “21600”：每6小时

  • “43200”：每12小时

  • “86400”：每天

alarm_template_name

String

告警模板下单个告警规则名称。

alarm_template_name_en

String

告警模板下单个告警规则英文名称。

desc

String

告警模板下单个告警规则描述。

desc_en

String

告警模板下单个告警规则英文描述。

alarm_template_spec_type

String

告警模板下单个告警规则类型。

“metric”：指标告警

“event”：事件告警

metric_alarm_template_spec

MetricAlarmTemplateSpec object

指标告警模板。

event_alarm_template_spec

EventAlarmTemplateSpec object

事件告警模板。

alarm_subtype

String

告警规则类别。

alarm_source

String

告警规则来源云服务：CCE 创建标识。

monitor_type

String

监控类型。

trigger_conditions

Array of TemplateTriggerCondition objects

触发条件。

no_data_conditions

Array of NoDataCondition objects

数据不足条件。

alarm_tags

Array of AlarmTags objects

告警标签。

recovery_conditions

RecoveryCondition object

告警恢复条件。

metric_query_mode

String

指标查询模式。

• “AOM”：AOM原生

• “PROM”：AOM Prometheus

• “NATIVE_PROM”：原生Prometheus

枚举值：

• AOM

• PROM

• NATIVE_PROM

metric_namespace

String

指标命名空间。

metric_name

String

指标名称。

metric_unit

String

指标单位。

metric_labels

Array of strings

指标维度。

promql

String

Prometheus语句。

promql_expr

String

Prometheus语句模板。

trigger_times

String

连续周期个数。

trigger_interval

String

检查频率周期。

• 当trigger_type 为“HOURLY”时，填“”

• 当trigger_type为“DAILY”时，格式为：“小时” 。例如每天凌晨三点"03:00"。

• 当trigger_type为“WEEKLY”时，格式为：“星期 小时”。例如每周一凌晨三点 “1 03:00”。

• 当trigger_type为“CRON”时，格式为标准CRON表达式。

• 当trigger_type为“FIXED_RATE”时，秒的取值为15s，30s，分钟为 1~59，小时为 1~24。例如“15s”，“30s”，“1min”，“1h”。

trigger_type

String

触发频率的类型：

• “FIXED_RATE”：固定间隔

• “HOURLY”：每小时

• “DAILY”：每天

• “WEEKLY”：每周

• “CRON”：Cron表达式

枚举值：

• FIXED_RATE

• HOURLY

• DAILY

• WEEKLY

• CRON

promql_for

String

持续时间。

持续时间范围：

• “0”：立即

• “15s”：15秒

• “30s”：30秒

• “1m”：1分钟

aggregation_type

String

检测规则：

• average：平均值

• minimum：最小值

• maximum：最大值

• sum：总计

• sampleCount：样本

operator

String

判断条件：“>”,“<”,“=”,“>=”,“<=”

thresholds

Map<String,String>

键值对形式，键为告警级别，值为告警阈值

aggregation_window

String

统计周期。

• “15s”：15秒

• “30s”：30秒

• “1m”：1分钟

• “5m”：5分钟

• “15m”：15分钟

• “1h”：1小时

cmdb

CmdbInfo object

cmdb信息。

query_match

String

查询筛选条件。

aom_monitor_level

String

监控层级。

aggregate_type

String

聚合方式。

• “by”：不分组

• “avg”

• “max”

• “min”

• “sum”

枚举值：

• by

• avg

• max

• min

• sum

metric_statistic_method

String

当配置方式为全量指标时可选择的指标运算方式。

• “single”：单个指标进行运算

• “mix”：多个指标进行混合运算

枚举值：

• single

• mix

expression

String

混合运算的表达式。

mix_promql

String

混合运算的promQL。

alarm_message_template

String

通知内容。

promql_monitor_templates

String

Prometheus监控模板。默认为cluster。

query_param

String

• PromQL告警规则，该参数为"{"defaultRule":{"label":"自定义","id":"custom"},"templateSelectd":null,"dimensionsList":[]}"

• 阈值告警规则，该参数为空。

app_id

String

应用id。

node_ids

Array of NodeInfo objects

节点信息列表。

node_type

String

节点类型。

node_id

String

节点id。

no_data_timeframe

Integer

无数据处理连续周期。取值范围为1~5。（当"notify_no_data"为true时，该参数必填，当"notify_no_data"为false时，该参数为空）

no_data_alert_state

String

数据不足时，阈值规则的状态。（当"notify_no_data"为true时，该参数必填，当"notify_no_data"为false时，该参数为空）

• “no_data”：数据不足并发送通知

• “alerting”：告警

• “ok”：正常

• “pre_state”：保持上一个状态

枚举值：

• no_data

• alerting

• ok

• pre_state

notify_no_data

Boolean

无数据处理开关。true表示启用无数据处理，false表示关闭无数据处理。

auto_tags

Array of strings

自动标签。

custom_tags

Array of strings

自定义标签。

custom_annotations

Array of strings

告警标注。

recovery_timeframe

Integer

告警恢复周期的个数。取值范围为1~3 (如果recovery_timeframe 参数不为空，该参数必填）

alarm_subtype

String

告警规则类别。

alarm_source

String

告警规则来源云服务：CCE 创建标识。

event_source

String

告警来源。

monitor_object_templates

Array of strings

监控对象模板（创建告警时需要补齐里面的内容）。

monitor_objects

Array of Map<String,String> objects

监控对象列表。键值对形式，键值为：

• “event_type”：通知类型

• “event_severity”：告警级别

• “event_name”：事件名称

• “namespace”：命名空间

• “clusterId”：集群id

• “customField”：用户自定义字段

trigger_conditions

Array of EventTriggerCondition objects

触发条件。

event_name

String

事件名称。

trigger_type

String

触发方式：

• “immediately”：立即触发

• “accumulative”：累计触发

枚举值：

• immediately

• accumulative

aggregation_window

Long

监控周期。单位为秒，例如 1小时 填“3600”，当trigger_type为“immediately”时 该参数为空，当trigger_type为“accumulative”时 该参数必填。

监控周期范围：

5分钟，20分钟，1小时，4小时，24小时。

operator

String

判断条件：“>”,“<”,“=”,“>=”,“<=”，当trigger_type为“immediately”时 该参数为空。当trigger_type为“accumulative”时 该参数必填。

thresholds

Map<String,Integer>

键值对形式，键为告警级别，值为累计次数，当trigger_type为“immediately”时 累计次数为1。当当trigger_type为“accumulative”时 累计次数范围为1~100 （如果trigger_conditions参数不为空，该参数必填）

frequency

String

事件类告警频率。当trigger_type为“immediately”时 值为-1。

• “-1”：N/A

• “0”：只告警一次

• “300”：每5分钟

• “600”：每10分钟：

• “900”：每15分钟：

• “1800”：每30分钟：

• “3600”：每1小时：

• “10800”：每3小时：

• “21600”：每6小时：

• “43200”：每12小时：

• “86400”：每天：

list

Array of TemplateInfo objects

变量列表。

name

String

变量名称。

type

String

变量类型。

query

String

变量值。

description

String

变量描述。

200

OK 请求响应成功。