Querying Metric or Event Alarm Rules

project_id

Yes

String

Project ID, which can be obtained from the console or by calling an API. For details, see Obtaining a Project ID.

name

No

String

Alarm rule name.

limit

No

String

Number of records that can be returned.

offset

No

String

Start position for a pagination query, which must be a non-negative integer.

sort_by

No

String

Whether to sort alarms by alarm rule name or alarm creation time.

• alarm_rule_name.asc

• alarm_create_time.desc

event_source

No

String

Source of an event alarm rule.

• RDS

• EVS

• CCE

• LTS

• AOM

event_severity

No

String

Alarm severity.

• Critical

• Major

• Minor

• Info

alarm_rule_status

No

String

Alarm rule status.

• OK: normal

• alarm: threshold-crossing

• Effective: in use

• Invalid: not in use

Enumeration values:

• OK

• alarm

• Effective

• Invalid

alarm_rule_type

No

String

Alarm rule type.

• metric: metric alarm rule

• event: event alarm rule

Enumeration values:

• metric

• event

prom_instance_id

No

String

Prometheus instance ID.

bind_notification_rule_id

No

String

Name of the bound alarm action rule.

related_cce_clusters

No

String

CCE cluster ID.

X-Auth-Token

Yes

String

User token obtained from IAM. For details, see Obtaining a Token.

Content-Type

No

String

Message body type or format. Content type, which is application/json.

Enterprise-Project-Id

No

String

Enterprise project ID. For details, see Obtaining an Enterprise Project ID.

• To query the instances in an enterprise project, enter the enterprise project ID.

• To query the instances in all enterprise projects, enter all_granted_eps.

alarm_rules

Array of AlarmParamForV4Db objects

Alarm rule list.

metadata

Object

Metadata information.

count

Integer

Number of alarm rules.

alarm_create_time

Long

Time when an alarm rule was created.

alarm_update_time

Long

Time when an alarm rule was modified.

alarm_rule_name

String

Alarm rule name.

alarm_rule_id

Long

Alarm rule ID.

enterprise_project_id

String

Enterprise project ID. For details, see Obtaining an Enterprise Project ID.

prom_instance_id

String

Prometheus instance ID.

alarm_rule_description

String

Alarm rule description.

alarm_rule_enable

Boolean

Enabled or not.

alarm_rule_status

String

Alarm status.

• OK: normal

• alarm: threshold-crossing

• Effective: in use

• Invalid: not in use

alarm_rule_type

String

Rule type.

• metric: metric alarm rule

• event: event alarm rule

Enumeration values:

• metric

• event

metric_alarm_spec

MetricAlarmSpec object

Structure of a metric alarm rule.

event_alarm_spec

EventAlarmSpec object

Structure of an event alarm rule.

alarm_notifications

AlarmNotification object

Alarm notification module.

user_id

String

User ID.

monitor_type

String

Monitoring type.

• all_metric: Select metrics from all metrics.

• promql: Select metrics using PromQL.

• resource (unavailable soon): Select metrics by resource type.

Enumeration values:

• all_metric

• promql

• resource

no_data_conditions

Array of NoDataCondition objects

Action taken for insufficient data.

alarm_tags

Array of AlarmTags objects

Alarm tags.

monitor_objects

Array of Map<String,String> objects

List of monitored objects.

recovery_conditions

RecoveryCondition object

Alarm clearance condition.

trigger_conditions

Array of TriggerCondition objects

Trigger conditions.

alarm_rule_template_bind_enable

Boolean

(Deprecated) Whether to bind an alarm rule template.

alarm_rule_template_id

String

(Deprecated) ID of the alarm rule template.

no_data_timeframe

Integer

Number of consecutive periods without data. Value range: 1–5. (If notify_no_data is set to true, this parameter is mandatory. If notify_no_data is set to false, leave this parameter blank.)

no_data_alert_state

String

Status of the threshold rule when the data is insufficient. (If notify_no_data is set to true, this parameter is mandatory. If notify_no_data is set to false, leave this parameter blank.)

• no_data: A notification indicating insufficient data is sent.

• alerting: An alarm is triggered.

• ok: No exception occurs.

• pre_state: Retain the previous state.

Enumeration values:

• no_data

• alerting

• ok

• pre_state

notify_no_data

Boolean

Whether to take action when no data is reported. true: Enable the function. false: Disable the function.

auto_tags

Array of strings

Automatic tag.

custom_tags

Array of strings

Custom tag.

custom_annotations

Array of strings

Alarm annotation.

recovery_timeframe

Integer

Number of consecutive periods for which the trigger condition is not met to clear an alarm. Value range: 1–3. (If recovery_timeframe is specified, this parameter is mandatory.)

metric_query_mode

String

Metric query mode.

• AOM: native AOM

• PROM: AOM Prometheus

• NATIVE_PROM: native Prometheus

Enumeration values:

• AOM

• PROM

• NATIVE_PROM

metric_namespace

String

Metric namespace.

metric_name

String

Metric name.

metric_unit

String

Metric unit.

metric_labels

Array of strings

Metric dimension.

promql

String

Prometheus statement.

promql_expr

Array of strings

Prometheus statement template.

trigger_times

Integer

Number of consecutive periods.

trigger_interval

String

Check interval.

• If trigger_type is set to HOURLY*, set this parameter to "".

• If trigger_type is set to DAILY, set 00:00–23:00. Example: 03:00.

• If trigger_type is set to WEEKLY, select a day in a week and then select 00:00–23:00. Example: **1 03:00" indicates 03:00 on every Monday.

• If trigger_type is set to CRON, specify a standard cron expression.

• If trigger_type is set to FIXED_RATE, select 15s, 30s, 1–59 min, or 1–24 h. Example: 15s, 30s, 1min, or 1h.

trigger_type

String

Trigger type.

• FIXED_RATE: fixed interval

• HOURLY: every hour

• DAILY: every day

• WEEKLY: every week

• CRON: Cron expression

Enumeration values:

• FIXED_RATE

• HOURLY

• DAILY

• WEEKLY

• CRON

promql_for

String

Native Prometheus monitoring duration.

aggregation_type

String

Statistical mode.

• average

• minimum

• maximum

• sum

• sampleCount

operator

String

Operator. Options: >, <, =, >=, and <=.

thresholds

Map<String,String>

Key-value pair. The key indicates the alarm severity while the value indicates the alarm threshold.

aggregation_window

String

Statistical period. Options:

• 15s: 15 seconds.

• 30s: 30 seconds.

• 1m: 1 minute.

• 5m: 5 minutes.

• 15m: 15 minutes.

• 1h: 1 hour.

cmdb

CmdbInfo object

CMDB information.

query_match

String

Query filter criteria.

query_param

Object

Query parameter.

aom_monitor_level

String

Monitoring layer.

aggregate_type

String

Aggregation method.

• by: not grouped.

• avg: average value.

• max": maximum value.

• "min": minimum value.

• "sum": sum.

Enumeration values:

• by

• avg

• max

• min

• sum

metric_statistic_method

String

Metric statistics method to be used when you set Configuration Mode to Select from all metrics during alarm rule setting.

• single: single metric

• mix: multi-metric combined operations

Enumeration values:

• single

• mix

expression

String

Expression of a combined operation.

mix_promql

String

PromQL of a combined operation.

app_id

String

Application ID.

node_ids

Array of NodeInfo objects

Node information list.

node_type

String

Node type.

node_id

String

Node ID.

alarm_source

String

Alarm rule source.

• systemEvent

• customEvent

Enumeration values:

• systemEvent

• customEvent

event_source

String

Alarm source.

• RDS

• EVS

• CCE

• LTS

• AOM

monitor_objects

Array of Map<String,String> objects

List of monitored objects. Key-value pair.

• event_type: notification type

• event_severity: alarm severity

• event_name: event name

• namespace: namespace

• clusterId: cluster ID

• customField: user-defined field

trigger_conditions

Array of EventTriggerCondition objects

Trigger conditions.

alarm_rule_template_bind_enable

Boolean

(Deprecated) Whether to bind an alarm rule template.

alarm_rule_template_id

String

(Deprecated) ID of the alarm rule template.

event_name

String

Event name.

trigger_type

String

Trigger mode.

• immediately: An alarm is triggered immediately if the alarm condition is met.

• accumulative: An alarm is triggered if the alarm condition is met for a specified number of times.

Enumeration values:

• immediately

• accumulative

aggregation_window

Long

Monitoring period. Unit: second. For example, 3600 indicates 1 hour. If trigger_type is set to immediately, leave this parameter blank. If trigger_type is set to accumulative, this parameter is mandatory.

Value range:

5 minutes, 20 minutes, 1 hour, 4 hours, or 24 hours.

operator

String

Operator. Options: >, <, =, >=, and <=. If trigger_type is set to immediately, leave this parameter blank. If trigger_type is set to accumulative, this parameter is mandatory.

thresholds

Map<String,Integer>

Key-value pair. The key indicates the alarm severity while the value indicates the number of accumulated trigger times. If trigger_type is set to immediately, the value is 1. If trigger_type is set to accumulative, the value ranges from 1 to 100. (This parameter is mandatory if trigger_conditions is specified.)

frequency

String

Event alarm notification frequency. If trigger_type is set to immediately, the value of this parameter is -1.

• -1: N/A.

• 0: alarm sent only once.

• 300: every 5 minutes.

• 600: every 10 minutes.

• 900: every 15 minutes.

• 1800: every 30 minutes.

• 3600: every hour.

• 10800: every 3 hours.

• 21600: every 6 hours.

• 43200: every 12 hours.

• 86400: every day.

notification_type

String

Notification type.

• direct: direct alarm reporting

• alarm_policy: alarm reporting after noise reduction

Enumeration values:

• direct

• alarm_policy

route_group_enable

Boolean

Whether to enable the alarm grouping rule.

• If the notification type is set to alarm_policy, set this parameter to true.

• If the notification type is set to direct, set this parameter to false.

If both notify_triggered and notify_resolved are set to false, route_group_enable must be set to false.

Enumeration values:

• true

• false

route_group_rule

String

Alarm grouping rule name.

• If route_group_enable is set to true, enter an alarm grouping rule name.

• If route_group_enable is set to false, enter "".

notification_enable

Boolean

Whether to enable the alarm notification rule.

• If the notification type is direct, set this parameter to true.

• If the notification type is alarm_policy, set this parameter to false.

If both notify_triggered and notify_resolved are set to false, notification_enable must be set to false.

bind_notification_rule_id

String

Alarm action rule ID.

• If notification_enable is set to true, enter an alarm action rule ID.

• If notification_enable is set to false, enter "".

notify_resolved

Boolean

Whether to send a notification when an alarm is cleared.

• true: Send a notification.

• false: Do not send any notification.

Enumeration values:

• true

• false

notify_triggered

Boolean

Whether to send a notification when an alarm is triggered.

• true: Send a notification.

• false: Do not send any notification.

Enumeration values:

• true

• false

notify_frequency

Integer

Notification frequency.

• If the notification type is alarm_policy, set this parameter to -1.

• If the notification type is direct, set this parameter to any of the following:

• 0: alarm sent only once

• 300: every 5 minutes

• 600: every 10 minutes

• 900: every 15 minutes

• 1800: every 30 minutes

• 3600: every hour

• 10800: every 3 hours

• 21600: every 6 hours

• 43200: every 12 hours

• 86400: every day

error_code

String

Error code.

error_msg

String

Error message.

error_type

String

Error type.

trace_id

String

Request ID.

200

OK: The request is successful.

500

Internal Server Error: The server is able to receive the request but unable to understand the request.