ApplyMetricRuleTemplate - CloudMonitor - Alibaba Cloud Documentation Center

Applies an alert template to an application group to generate an alert rule.

Operation description

In this example, the 700**** alert template is applied to the 123456 application group. For the generated alert rule, the ID is applyTemplate8ab74c6b-9f27-47ab-8841-de01dc08****, and the name is test123.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
SilenceTime	long	No	The mute period during which notifications are not repeatedly sent for an alert. Unit: seconds. Default value: 86400. Note Only one alert notification is sent during each mute period even if the metric value exceeds the alert threshold several times.	86400
GroupId	long	Yes	The ID of the application group to which the alert template is applied. For more information about how to query the ID of an application group, see DescribeMonitorGroups .	123456
TemplateIds	string	Yes	The ID of the alert template. For more information about how to query the IDs of alert templates, see DescribeMetricRuleTemplateList .	700****
EnableStartTime	long	No	The beginning of the time period during which the alert rule is effective. Valid values: 00 to 23. A value of 00 indicates 00:00 and a value of 23 indicates 23:00.	00
EnableEndTime	long	No	The end of the time period during which the alert rule is effective. Valid values: 00 to 23. A value of 00 indicates 00:59 and a value of 23 indicates 23:59.	23
NotifyLevel	long	No	The alert notification method. Valid values: Set the value to 4. A value of 4 indicates that alert notifications are sent by using TradeManager and DingTalk chatbots.	4
ApplyMode	string	No	The mode in which the alert template is applied. Valid values: GROUP_INSTANCE_FIRST: The metrics in the application group take precedence. If a metric specified in the alert template does not exist in the application group, the system does not generate an alert rule for the metric based on the alert template. ALARM_TEMPLATE_FIRST: The metrics specified in the alert template take precedence. If a metric specified in the alert template does not exist in the application group, the system still generates an alert rule for the metric based on the alert template.	GROUP_INSTANCE_FIRST
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

For more information about common request parameters, see Common parameters.

Response parameters

Parameter	Type	Description	Example
	object
Code	integer	The response code. Note The HTTP status code 200 indicates that the call succeeds.	200
Message	string	The error message returned.	The specified resource is not found.
RequestId	string	The ID of the request.	3F897F3C-020A-4993-95B4-63ABB84F83E6
Success	boolean	Indicates whether the call succeeds. Valid values: true: The call succeeds. false: The call fails.	true
Resource	object	The resources that are affected by the alert rule.
GroupId	long	The ID of the application group to which the alert template is applied.	123456
AlertResults	object []	The details of the generated alert rule.
Code	string	The response code. Note The HTTP status code 200 indicates that the call succeeds.	200
Message	string	The returned information.	alert rule is creating, please wait a few minutes.
Success	boolean	Indicates whether the call succeeds. Valid values: true: The call succeeds. false: The call fails.	true
RuleName	string	The name of the alert rule.	test123
RuleId	string	The ID of the alert rule.	applyTemplate8ab74c6b-9f27-47ab-8841-de01dc08****

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "Message": "The specified resource is not found.",
  "RequestId": "3F897F3C-020A-4993-95B4-63ABB84F83E6",
  "Success": true,
  "Resource": {
    "GroupId": 123456,
    "AlertResults": [
      {
        "Code": "200",
        "Message": "alert rule is creating, please wait a few minutes.",
        "Success": true,
        "RuleName": "test123",
        "RuleId": "applyTemplate8ab74c6b-9f27-47ab-8841-de01dc08****"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	ParameterInvalid	Illegal parameters.	-
403	AccessForbidden	User not authorized to operate on the specified resource.	-
404	ResourceNotFound	The specified resource is not found.	The specified resource is not found.
500	InternalError	The request processing has failed due to some unknown error.	-

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2024-02-27

The Error code has changed. The request parameters of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 403
	delete Error Codes: 404
	delete Error Codes: 500
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: AppendMode