Querying SQL Alarm Rules
Function
This API is used to query a SQL alarm.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/lts/alarms/sql-alarm-rule
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Project ID. It can be obtained by calling an API or from the console. For details, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition User token obtained from IAM. For details about how to obtain it, see Obtaining a User Token. Constraints N/A Range N/A Default Value N/A |
Content-Type |
Yes |
String |
Definition Message body format. Set this parameter to application/json;charset=utf8. Constraints N/A Range N/A Default Value N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
sql_alarm_rules |
Array of SqlAlarmRuleRespList objects |
Definition SQL alarm rule information. |
Parameter |
Type |
Description |
---|---|---|
sql_alarm_rule_name |
String |
Definition SQL alarm rule name. Range N/A |
is_css_sql |
Boolean |
Definition Whether to use the SQL query with the pipe character (|). Range
|
sql_alarm_rule_id |
String |
Definition SQL alarm rule ID. Range N/A |
sql_alarm_rule_description |
String |
Definition Brief description of a SQL alarm rule. Range N/A |
sql_requests |
Array of SqlRequestResponse objects |
Definition SQL alarm rule information. |
frequency |
FrequencyRespBody object |
Definition SQL alarm query frequency. |
condition_expression |
String |
Definition Condition expression for triggering an alarm. Range N/A |
topics |
Array of Topics objects |
Definition SMN topic information. |
sql_alarm_level |
String |
Definition Alarm severity. Range
|
domain_id |
String |
Definition Account ID. Range N/A |
create_time |
Long |
Definition Time when the SQL alarm rule was created (timestamp in milliseconds). Range N/A |
update_time |
Long |
Definition Time when the SQL alarm rule was modified (timestamp in milliseconds). Range N/A |
template_name |
String |
Definition Message template name. Range N/A |
status |
String |
Definition Alarm status. Range
|
trigger_condition_count |
Integer |
Definition Alarm triggering condition: number of times the condition is met. It specifies the number of times a specified SQL statement's condition must be met to trigger an alarm. Range N/A |
trigger_condition_frequency |
Integer |
Definition Alarm triggering condition: number of queries. It refers to the number of queries set in the advanced settings. Range N/A |
whether_recovery_policy |
Boolean |
Definition Whether to configure an alarm restoration policy. If this policy is met, an alarm restoration notification is sent. Range
|
recovery_policy |
Integer |
Definition Number of consecutive queries in which the alarm's trigger condition must not be met. Range N/A |
notification_frequency |
Integer |
Definition Alarm notification frequency. Range
|
alarm_action_rule_name |
String |
Definition Alarm action rule name. Range N/A |
tags |
Array of tagsResBody objects |
Definition Alarm tag information. |
Parameter |
Type |
Description |
---|---|---|
log_stream_id |
String |
Definition Log stream ID. Range N/A |
log_stream_name |
String |
Definition Log stream name. Range N/A |
log_group_id |
String |
Definition Log stream ID. Range N/A |
log_group_name |
String |
Definition Log group name. Range N/A |
sql |
String |
Definition SQL statement. Range N/A |
sql_request_title |
String |
Definition Chart associated with alarms. Range N/A |
search_time_range |
Integer |
Definition Time range for querying the latest data when an alarm task is executed. Range N/A |
search_time_range_unit |
String |
Definition Unit of the alarm query time range. Range
|
Parameter |
Type |
Description |
---|---|---|
type |
String |
Definition Query frequency type of alarms. Range
|
cron_expr |
String |
Definition Cron expression. This parameter is returned when type is set to CRON. Cron expressions use the 24-hour format and are precise down to the minute. Range N/A |
hour_of_day |
Integer |
Definition Every hour of every day. This parameter is returned when type is set to DAILY or HOURLY. Range N/A |
day_of_week |
Integer |
Definition Weekly. This parameter is returned when type is set to WEEKLY. Range N/A |
fixed_rate |
Integer |
Definition Fixed interval. This parameter is returned when type is set to FIXED_RATE. Range N/A |
fixed_rate_unit |
String |
Definition Unit of the fixed interval. Range
|
Parameter |
Type |
Description |
---|---|---|
name |
String |
Definition SMN topic name. Range N/A |
topic_urn |
String |
Definition Unique resource ID of the SMN topic. Range N/A |
display_name |
String |
Definition Sender name displayed in an email. Range N/A |
push_policy |
Integer |
Definition Message push policy. Currently, this attribute is not modifiable. Support for modifying this setting will be added in a future update. Range
|
Parameter |
Type |
Description |
---|---|---|
key |
String |
Definition Tag key. Range N/A |
value |
String |
Definition Tag value. Range N/A |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition Error code. For details, see Error Codes. Range N/A |
error_msg |
String |
Definition Error message. Range N/A |
Example Requests
Query SQL alarm rules.
GET https://{endpoint}/v2/{project_id}/lts/alarms/sql-alarm-rule /v2/{project_id}/lts/alarms/sql-alarm-rule
Example Responses
Status code: 200
The request is successful.
{ "sql_alarm_rules" : [ { "sql_alarm_rule_name" : "string", "is_css_sql" : false, "sql_alarm_rule_id" : "string", "sql_alarm_rule_description" : "string", "sql_requests" : [ { "log_stream_id" : "string", "log_stream_name" : "string", "log_group_id" : "string", "log_group_name" : "string", "sql" : "string", "sql_request_title" : "string", "search_time_range" : 0, "search_time_range_unit" : "minute" } ], "frequency" : { "type" : "CRON", "cron_expr" : "string", "hour_of_day" : 0, "day_of_week" : 0, "fixed_rate" : 0, "fixed_rate_unit" : "minute" }, "condition_expression" : "string", "sql_alarm_level" : "Info", "domain_id" : "string", "create_time" : 0, "update_time" : 0, "template_name" : "Message template name.", "status" : "RUNNING", "trigger_condition_count" : "1", "trigger_condition_frequency" : "1", "whether_recovery_policy" : false, "recovery_policy" : "3", "notification_frequency" : 5, "alarm_action_rule_name" : "" } ] }
Status code: 500
The server has received the request but encountered an internal error.
{ "error_code" : "LTS.2008", "error_msg" : "Find Alarm rule failed." }
Status Codes
Status Code |
Description |
---|---|
200 |
The request is successful. |
500 |
The server has received the request but encountered an internal error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot