Queries the details of an alert rule.

Request method

Use the POST method to send the request.

Request parameters

The following table lists only the request parameters specific to this API and some common parameters. For the complete list of common parameters, see Common parameters.

Field	Position	Type	Required	Description	Sample value
Action	Query	String	Yes	The API name, which is a common parameter.	GetAlertRuleDetail
Version	Query	String	Yes	The API version, which is a public parameter.	2022-07-11
Id	RequestBody	Int64	Yes	The alert configuration ID.	-

Response parametersThe Result parameter contains the following fields:

Field	Type	Description
Id	Int32	The API name, which is a common parameter.
Config	AlertRuleConfig	The alert configuration.
Status	AlertRuleStatus	The alert status.

AlertRuleConfig

Field	Type	Description
Name	String	The alert name.
Desc	String	The alert description.
AlertStrategy	AlertStrategy	The alert policy.
NotifyConfig	NotifyConfig	The alert notification configuration.

NotifyConfig

Field	Type	Description
NotifyInterval	Int32	The notification interval.
NotifyTypes	Array[String]	The alert type. email lark
NotifyLarkWebhooks	Array[String]	The Feishu webhooks.
NotifyWebhooks	Array[String]	The common webhooks.
NotifyGroup	Array[Int32]	The alert group ID.

AlertStrategy

Field	Type	Description
AlertType	String	The alert type. host process container custom_metric
AlertLevel	Array[String]	The alert level.
LogicOperator	String	The multiple-policy relationship. and or
ExecuteInterval	Int32	The alert execution interval. Unit: minutes.
MetricConfig	Array[AlertMetricConfig]	The metric policy.

AlertMetricConfig

Field	Type	Description
ScanWindow	Int32	The detection time window. Unit: minutes.
RollupTimeframeByAggregator	String	Time window aggregation method. AVG SUM LAST COUNT MAX MIN
AlertMetric	AlertMetric	The alert execution interval. Unit: minutes.
CompareConfigList	Map[AlertCompareConfig]	The metric policy.

AlertCompareConfig

Field	Type	Description
CompareType	String	Threshold: thershold Comparison: window
CompareOp	String	Threshold: > < <= >= = Comparison: increase increase_percent decrease decrease_percent abs abs_percent
Level	String	The alert level is the same as MapKey.
WindowSize	Int3	The data sampling window size. Unit: seconds.
Value	Float64	The threshold.

AlertMetric

Field	Type	Description
IsFormula	Boolean	Whether it is a composite alert.
SimpleMetric	AlertSimpleMetric	The simple alert metric. When IsFormula is set to true, leave this parameter empty.
FormulaMetric	AlertFormulaMetric	The composite alert metric. When IsFormula is set to false, leave this parameter empty.

AlertSimpleMetric

Field	Type	Description
AlertSimpleMetric	Array[AlertSimpleMetric]	The simple alert metric.
FormulaQuery	FormulaQuery	The composite metric configuration.

FormulaQuery

Field	Type	Description
Formula	String	Composite metric calculation formula.
Alias	String	Displayed name.
Unit	String	Unit.
Alphabet	String	Symbols used for calculation formulas.

AlertSimpleMetric

Field	Type	Description
Ispromql	Boolean	Whether it is a PromQL metric.
Promql	String	PromQL query.
Metric	String	The metric name.
Unit	String	Unit.
Alphabet	String	The symbol used in the composite metric formula.
MetricCategory	String	Metric type. host process container custom_metric
MetricSource	String	Metric type. prometheus influxdb
GroupByFields	Array[String]	Grouping.
Aggregator	String	Group aggregation function.
AddFunc	String	Post-processing function. diff per_second_rate per_minute_rate per_second per_minute
Filters	Array[FilterCondition]	Filter condition.

FilterCondition

Field	Type	Description
Key	String	The tag name for filtering.
Op	String	The operator for filtering. < > = <= >=
Values	String	Unit.

AlertRuleStatus

Field	Type	Description
CreateBy	User	The user who created the alert.
UpdateBy	User	The user who last modified the alert.
CreateAt	Int64	Creation time.
UpdateAt	Int64	The last update time.
AlertCount	Int64	The alert count.
LastMonthAlertCount	Int64	The alert count in the last month.
LastExecuteTime	Int64	The last alert time.
NextTriggerTime	Int64	The next execution time.
EnableStatus	Boolean	Whether the alert is enabled.
AlertStatus	Boolean	Whether it is deleted.
InAck	Boolean	Whether the alert is acknowledged.
AckUntilTime	int64	The time until which the acknowledgement is valid.

Sample request

Sample response

Application Performance Management Plus