Docs

Cloud Monitor

Callback

Request content for a metric alert callback

When an alert policy is triggered and an aggregation condition for sending an alert notification is met, Cloud Monitor sends a POST request to the specified URL through the alert callback API. The request content for a metric alert callback includes the callback request header (Header) and the callback request body (Body).

Callback request header

Header Key	Header Value	Descriptions
x-volc-trace-id	Random UUID	This parameter is used for tracing the request.
x-volc-rule-id	{ rule_id }	The policy ID.

Callback request body

Data type

The request body is of the application/json data type.

Request body parameters

Parameters	Type	Sample value	Descriptions
Type	String	Metric	The alert type. Metric: threshold alert Event: event alert MetricRecovered: alert recovery MetricsNoData: NoData alert NoDataRecovered: NoData alert recovery
AccountId	String	20*****007	The account ID.
RuleName	String	Test alert policy	The policy name.
RuleId	String	1574726******98880	The policy ID.
Namespace	String	VCM_FileNAS	The service type.
SubNamespace	String	latency	The dimension.
Level	String	critical	The alert level. Valid values: critical warning notice
HappenedAt	String	2024-04-11 14:51:01(UTC+08:00)	The time when the alert is triggered.
RuleCondition	String	Multi-metric alert (any): Average CPU utilization > 90% for consecutive 10 cycles (1 cycle = 1 minute) Average memory utilization > 90% for consecutive 10 cycles (1 cycle = 1 minute)	The details of the alert policy.
Resources	Array	-	The resource details of the alert notification. For the specific format, refer to the Resource structure section of this topic.
RecoveredResources	Array	-	The resource details of the alert recovery notification. For the specific format, refer to the Resource structure section of this topic.
NoDataResources	Array	-	The resource details of the NoData alert. For the specific format, refer to the Resource structure section of this topic.
NoDataRecoveredResources	Array	-	The resource details of the NoData alert recovery notification. For the specific format, refer to the Resource structure section of this topic.

Resource structure

Parameters	Type	Sample value	Descriptions
Id	String	enas-cn04*****45d06f	The resource ID.
Name	String	enas-cn04*****45d06f	The resource name.
Region	String	cn-north-3	The region.
FirstAlertTime	Int	1664332705	The time when the alert was triggered for the first time.
LastAlertTime	Int	1664332705	The time when the alert is triggered.
Metrics	Object	-	The resolved metrics. This field applies to threshold alerts. For the specific format, refer to the Metric structure section of this topic.
NoDataMetrics	Object	-	The metric with no data reported. This field applies to NoData alerts.
DroppedMetrics	Object	-	The unresolved metrics. For example, if this parameter is set to NaN, division is used for alert calculation in some scenarios, but the divisor is 0. As a result, the calculation result is deemed unresolvable.
AlertGroupId	String	673******a06	The ID of the alert record.
Dimensions	Object	-	The resource dimension. For the specific format, refer to the Dimension structure section of this topic.

Metric structure

Parameters	Type	Sample value	Descriptions
Name	String	Nfsv3WriteLatency	The metric name.
Unit	String	ms	The metric unit.
Threshold	Float	1	The metric threshold of the policy.
CurrentValue	Float	0.0001	The current value of the metric.
Description	String	NFSv3 write latency	The description of the metric.
Warning	Bool	true	The metric triggers an alert. This parameter is available only when the metric triggers an alert.

Dimension structure

Parameters	Type	Sample value	Descriptions
Name	String	ResourceID	The metric dimension.
Value	String	enas-cn04*****45d06f	The value of the dimension.
NameCN	String	Instance ID	The dimension name in Chinese.

Sample request body

tip

You can ignore parameters without descriptions in the received request body. These parameters do not prevent you from obtaining the details of the alert notification.

alert notification request body

Alert recovery notification request body

NoData alert notification request body

NoData alert recovery notification request body

Last updated: 2026.07.10 14:02:23