PutCustomMetricRule - Cloud Monitor - Alibaba Cloud Documentation Center

Creates a custom alert rule.

Operation description

Before you call this operation, call the PutCustomMetric operation to report custom monitoring data. For more information, see PutCustomMetric.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cms:PutCustomMetricRule

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	No	The ID of the application group to which the custom monitoring data belongs. Note The value 0 indicates that the reported custom monitoring data does not belong to an application group.	7378****
RuleId	string	Yes	The ID of the alert rule. Note You can specify an existing ID to modify the corresponding alert rule or specify a new ID to create an alert rule.	MyRuleId1
RuleName	string	No	The name of the alert rule.	CpuUsage
MetricName	string	Yes	The metric name. Note For more information about how to obtain the metric name, see DescribeCustomMetricList.	cpu_total
Resources	string	Yes	The custom monitoring data to which the alert rule applies. The value includes the application group ID to which the custom monitoring data belongs and the dimension to which the metric belongs.	[{"groupId":7378**,"dimension":"instanceId=i-hp3543t5e4sudb3s**"}]
ContactGroups	string	Yes	The alert contact groups. Separate multiple alert contact groups with commas (,).	ECS_Group
Webhook	string	No	The callback URL to which a POST request is sent when an alert is triggered based on the alert rule.	https://www.aliyun.com
EffectiveInterval	string	No	The period of time during which the alert rule is effective. Valid values: 00:00 to 23:59.	00:00-23:59
SilenceTime	integer	No	The mute period during which new alert notifications are not sent even if the trigger conditions are met. Unit: seconds. Default value: 86400, which is equivalent to one day. Note Only one alert notification is sent during each mute period even if the metric value exceeds the alert threshold several times.	86400
Period	string	No	The cycle that is used to aggregate custom monitoring data. Unit: seconds Set the value to an integral multiple of 60. The original reporting cycle of custom monitoring data is used by default.	300
EmailSubject	string	No	The subject of the alert notification email.	ECS实例
Threshold	string	Yes	The alert threshold.	90
Level	string	Yes	The alert level. Valid values: CRITICAL WARN INFO	CRITICAL
EvaluationCount	integer	Yes	The consecutive number of times for which the metric value meets the alert condition before an alert is triggered.	3
Statistics	string	Yes	The method used to calculate the metric value based on which alerts are triggered.	Average
ComparisonOperator	string	Yes	The operator that is used to compare the metric value with the threshold. Valid values: `>=` `=` `<=` `>` `<` `!=`	>=

Response elements

Element	Type	Description	Example
	object
Code	string	The status code. Note The status code 200 indicates that the request was successful.	200
Message	string	The returned message. If the request was successful, the return value is null. If the request failed, an error message is returned.	ComparisonOperator is mandatory for this action.
RequestId	string	The request ID.	65D50468-ECEF-48F1-A6E1-D952E89D9432
Success	boolean	Indicates whether the request was successful. Valid values: true false	true

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "ComparisonOperator is mandatory for this action.",
  "RequestId": "65D50468-ECEF-48F1-A6E1-D952E89D9432",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message
400	%s	%s
499	%s	%s
500	InternalError	The request processing has failed due to some unknown error.
204	%s	%s
403	%s	%s
206	%s	%s
404	%s	%s
503	%s	%s
406	%s	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.