Querying SQL Alarm Rules

project_id

Yes

String

Project ID. For details about how to obtain a project ID, see Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID.

Minimum: 32

Maximum: 32

X-Auth-Token

Yes

String

User token obtained from IAM. For details about how to obtain a user token, see Obtaining a User Token.

Minimum: 1000

Maximum: 2000

Content-Type

Yes

String

Set this parameter to application/json;charset=UTF-8.

Minimum: 30

Maximum: 30

sql_alarm_rules

Array of SqlAlarmRuleRespList objects

SQL alarms.

sql_alarm_rule_name

String

SQL alarm name.

Minimum: 1

Maximum: 64

is_css_sql

Boolean

Whether to use the SQL query with the pipe character.

Default: false

sql_alarm_rule_id

String

SQL alarm rule ID.

Minimum: 36

Maximum: 36

sql_alarm_rule_description

String

SQL alarm description.

Minimum: 0

Maximum: 64

sql_requests

Array of SqlRequest objects

SQL details.

frequency

FrequencyRespBody object

Alarm statistical period.

condition_expression

String

Condition expression.

Minimum: 1

Maximum: 1024

topics

Array of Topics objects

Topic information.

sql_alarm_level

String

Alarm severity.

sql_alarm_send

Boolean

Whether to send an alarm.

domain_id

String

domainId

Minimum: 32

Maximum: 32

create_time

Long

Creation time (timestamp in milliseconds).

Minimum: 13

Maximum: 13

update_time

Long

Update time (timestamp in milliseconds).

Minimum: 13

Maximum: 13

template_name

String

Message template name.

status

String

Alarm status.

trigger_condition_count

Integer

Number of queries in which the triggering condition is met. The default value is 1.

trigger_condition_frequency

Integer

Number of queries in which the triggering condition is met. The default value is 1.

whether_recovery_policy

Boolean

Whether to enable the alarm clearance notification. The default value is false.

recovery_policy

Integer

Number of queries in which the triggering condition is not met. The alarm is cleared when this number reaches the value (3 by default) of this parameter.

notification_frequency

Integer

Notification frequency, in minutes.

alarm_action_rule_name

String

Alarm action rule name.

is_time_range_relative

Boolean

The time range is relative.

log_stream_id

String

Log stream ID.

Minimum: 36

Maximum: 36

log_stream_name

String

Log stream name.

Minimum: 1

Maximum: 64

log_group_id

String

Log group ID.

Minimum: 36

Maximum: 36

log_group_name

String

Log group name.

Minimum: 1

Maximum: 64

sql

String

SQL statement.

Minimum: 1

Maximum: 1024

sql_request_title

String

Chart name.

Minimum: 1

Maximum: 64

search_time_range

Integer

Time range for querying the latest data when a task is executed. If search_time_range_unit is set to minute, the maximum value is 60. If search_time_range_unit is set to hour, the maximum value is 24.

Minimum: 1

Maximum: 60

search_time_range_unit

String

Query time unit.

type

String

Time type.

cron_expr

String

This field is used when type is set to CRON.

Minimum: 1

Maximum: 1024

hour_of_day

Integer

This field is used when type is set to DAILY or WEEKLY.

day_of_week

Integer

This field is used when type is set to WEEKLY (Sunday to Saturday).

fixed_rate

Integer

This field is used when type is set to FIXED_RATE. If the unit of fixed_rate_unit is minute, the maximum value is 60. If the unit is hour, the maximum value is 24.

fixed_rate_unit

String

Enumerated values of the time unit:

name

String

Topic name.

Minimum: 1

Maximum: 1024

topic_urn

String

Specifies the resource identifier of the topic, which is unique.

Minimum: 1

Maximum: 1024

display_name

String

Specifies the topic display name, which is presented as the name of the email sender in email messages.

Minimum: 1

Maximum: 1024

push_policy

Integer

Specifies the message push policy.

Minimum: 1

Maximum: 1024

error_code

String

Error code.

error_msg

String

Error message.

200

The request is successful.

500

The server has received the request but encountered an internal error.