DescribeMetricRuleTemplateAttribute - CloudMonitor - Alibaba Cloud Documentation Center

Queries the details of an alert template.

Operation description

This topic provides an example on how to query the details of an alert template whose ID is 70****.

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
Name	string	No	The name of the alert template. You must specify at least one of the `Name` and `TemplateId` parameters. For information about how to obtain the name of an alert template, see DescribeMetricRuleTemplateList .	ECS_Template1
TemplateId	string	No	The ID of the alert template. You must specify at least one of the `Name` and `TemplateId` parameters. For information about how to obtain the ID of an alert template, see DescribeMetricRuleTemplateList .	70****

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

Response parameters

Parameter	Type	Description	Example
	object	The returned result.
Code	integer	The HTTP status code. Note The status code 200 indicates that the request was successful.	200
Message	string	The error message returned.	The specified resource is not found.
RequestId	string	The request ID.	8F3A82AD-DA92-52B0-8EC6-C059D1C3839F
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Resource	object	The details of the alert template.
Description	string	The description of the alert template.
Name	string	The name of the alert template.	ECS_Template1
RestVersion	string	The version of the alert template.	1
TemplateId	string	The ID of the alert template.	70****
AlertTemplates	object []	The queried alert templates.
MetricName	string	The metric name.	cpu_total
Selector	string	The dimension of the alert. It is an extended field.	{"disk":"/"}
Webhook	string	The callback URL to which a request is sent when an alert is triggered.	https://www.aliyun.com
Namespace	string	The namespace of the Alibaba Cloud service.	acs_ecs_dashboard
Category	string	The abbreviation of the Alibaba Cloud service name.	ecs
RuleName	string	The name of the alert rule.	ECS_Rule
NoDataPolicy	string	The method that is used to handle alerts when no monitoring data is found. Valid values: KEEP_LAST_STATE (default): No operation is performed. INSUFFICIENT_DATA: An alert whose content is "Insufficient data" is triggered. OK: The status is considered normal.	KEEP_LAST_STATE
Escalations	object	The threshold and the alert level.
Info	object	The conditions for triggering Info-level alerts.
ComparisonOperator	string	The comparison operator that is used to compare the metric value with the threshold for Info-level alerts. Valid values: GreaterThanOrEqualToThreshold: greater than or equal to the threshold GreaterThanThreshold: greater than the threshold LessThanOrEqualToThreshold: less than or equal to the threshold LessThanThreshold: less than the threshold NotEqualToThreshold: not equal to the threshold GreaterThanYesterday: greater than the metric value at the same time yesterday LessThanYesterday: less than the metric value at the same time yesterday GreaterThanLastWeek: greater than the metric value at the same time last week LessThanLastWeek: less than the metric value at the same time last week GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle LessThanLastPeriod: less than the metric value in the last monitoring cycle	GreaterThanOrEqualToThreshold
Times	integer	The consecutive number of times for which the metric value meets the alert condition before an Info-level alert is triggered.	3
Threshold	string	The threshold for Info-level alerts.	90
Statistics	string	The statistical method for Info-level alerts. The value of the `Statistics` parameter varies with the cloud service. For more information, see Appendix 1: Metrics.	Average
Warn	object	The conditions for triggering Warn-level alerts.
ComparisonOperator	string	The comparison operator that is used to compare the metric value with the threshold for Warn-level alerts. Valid values: GreaterThanOrEqualToThreshold: greater than or equal to the threshold GreaterThanThreshold: greater than the threshold LessThanOrEqualToThreshold: less than or equal to the threshold LessThanThreshold: less than the threshold NotEqualToThreshold: not equal to the threshold GreaterThanYesterday: greater than the metric value at the same time yesterday LessThanYesterday: less than the metric value at the same time yesterday GreaterThanLastWeek: greater than the metric value at the same time last week LessThanLastWeek: less than the metric value at the same time last week GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle LessThanLastPeriod: less than the metric value in the last monitoring cycle	GreaterThanOrEqualToThreshold
Times	integer	The consecutive number of times for which the metric value meets the alert condition before a Warn-level alert is triggered.	3
Threshold	string	The threshold for Warn-level alerts.	90
Statistics	string	The statistical method for Warn-level alerts. The value of the `Statistics` parameter varies with the cloud service. For more information, see Appendix 1: Metrics.	Average
Critical	object	The conditions for triggering Critical-level alerts.
ComparisonOperator	string	The comparison operator that is used to compare the metric value with the threshold for Critical-level alerts. Valid values: GreaterThanOrEqualToThreshold: greater than or equal to the threshold GreaterThanThreshold: greater than the threshold LessThanOrEqualToThreshold: less than or equal to the threshold LessThanThreshold: less than the threshold NotEqualToThreshold: not equal to the threshold GreaterThanYesterday: greater than the metric value at the same time yesterday LessThanYesterday: less than the metric value at the same time yesterday GreaterThanLastWeek: greater than the metric value at the same time last week LessThanLastWeek: less than the metric value at the same time last week GreaterThanLastPeriod: greater than the metric value in the last monitoring cycle LessThanLastPeriod: less than the metric value in the last monitoring cycle	GreaterThanOrEqualToThreshold
Times	integer	The consecutive number of times for which the metric value meets the alert condition before a Critical-level alert is triggered.	5
Threshold	string	The threshold for Critical-level alerts.	90
Statistics	string	The statistical method for Critical-level alerts. The value of the `Statistics` parameter varies with the cloud service. For more information, see Appendix 1: Metrics.	Average
Labels	object []	The tags of the alert template.
Key	string	The tag key of the alert template.	label1
Value	string	The tag value of the alert template.	value1

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "Message": "The specified resource is not found.",
  "RequestId": "8F3A82AD-DA92-52B0-8EC6-C059D1C3839F",
  "Success": true,
  "Resource": {
    "Description": "",
    "Name": "ECS_Template1",
    "RestVersion": "1",
    "TemplateId": "70****",
    "AlertTemplates": {
      "AlertTemplate": [
        {
          "MetricName": "cpu_total",
          "Selector": "{\"disk\":\"/\"}",
          "Webhook": "https://www.aliyun.com",
          "Namespace": "acs_ecs_dashboard",
          "Category": "ecs",
          "RuleName": "ECS_Rule",
          "NoDataPolicy": "KEEP_LAST_STATE",
          "Escalations": {
            "Info": {
              "ComparisonOperator": "GreaterThanOrEqualToThreshold",
              "Times": 3,
              "Threshold": "90",
              "Statistics": "Average"
            },
            "Warn": {
              "ComparisonOperator": "GreaterThanOrEqualToThreshold",
              "Times": 3,
              "Threshold": "90",
              "Statistics": "Average"
            },
            "Critical": {
              "ComparisonOperator": "GreaterThanOrEqualToThreshold",
              "Times": 5,
              "Threshold": "90",
              "Statistics": "Average"
            }
          },
          "Labels": {
            "Labels": [
              {
                "Key": "label1",
                "Value": "value1"
              }
            ]
          }
        }
      ]
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	ParameterInvalid	Illegal parameters.	-
400	%s	%s	-
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

2022-12-26

The Error code has changed. The response structure 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: 409
	delete Error Codes: 412
	delete Error Codes: 500
Output Parameters	The response structure of the API has changed.

2022-12-22

The Error code has changed. The response structure 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: 409
	delete Error Codes: 412
	delete Error Codes: 500
Output Parameters	The response structure of the API has changed.