调用DescribeMetricRuleTemplateAttribute查询报警模板详情-云监控-阿里云-云监控(CMS)-阿里云帮助中心

调用DescribeMetricRuleTemplateAttribute接口查询报警模板详情。

接口说明

本文将提供一个示例，查询报警模板70****的详情。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
Name	string	否	报警模板名称。`Name`和`TemplateId`必须设置一个。关于如何获取报警模板名称，请参见 DescribeMetricRuleTemplateList 。	ECS_Template1
TemplateId	string	否	报警模板 ID。`Name`和`TemplateId`必须设置一个。关于如何获取报警模板 ID，请参见 DescribeMetricRuleTemplateList 。	70****

关于公共请求参数的详情，请参见公共参数。

返回参数

名称	类型	描述	示例值
	object	返回结果。
Code	integer	状态码。说明 200 表示成功。	200
Message	string	错误信息。	The specified resource is not found.
RequestId	string	请求 ID。	8F3A82AD-DA92-52B0-8EC6-C059D1C3839F
Success	boolean	操作是否成功。取值： true：成功。 false：失败。	true
Resource	object	报警模板详情。
Description	string	报警模板描述信息。	ECS模板
Name	string	报警模板名称。	ECS_Template1
RestVersion	string	报警模板版本。	1
TemplateId	string	报警模板 ID。	70****
AlertTemplates	object
AlertTemplate	array<object>	报警模板列表。
	array<object>	报警模板。
MetricName	string	监控项名称。	cpu_total
Selector	string	报警维度扩展选项。	{"disk":"/"}
Webhook	string	触发报警回调的 URL 地址。	https://www.aliyun.com
Namespace	string	云服务的命名空间。	acs_ecs_dashboard
Category	string	云服务名称缩写。	ecs
RuleName	string	报警规则名称。	ECS_Rule
NoDataPolicy	string	无监控数据时报警的处理方式。取值： KEEP_LAST_STATE（默认值）：不做任何处理。 INSUFFICIENT_DATA：报警内容为无数据。 OK：正常。	KEEP_LAST_STATE
Escalations	object	阈值及报警级别。
Info	object	Info 级别报警触发条件。
ComparisonOperator	string	Info 级别的阈值比较符。取值： GreaterThanOrEqualToThreshold：大于等于。 GreaterThanThreshold：大于。 LessThanOrEqualToThreshold：小于等于。 LessThanThreshold：小于。 NotEqualToThreshold：不等于。 GreaterThanYesterday：同比昨天时间上涨。 LessThanYesterday：同比昨天时间下降。 GreaterThanLastWeek：同比上周同一时间上涨。 LessThanLastWeek：同比上周同一时间下降。 GreaterThanLastPeriod：环比上周期上涨。 LessThanLastPeriod：环比上周期下降。	GreaterThanOrEqualToThreshold
Times	integer	Info 级别的重试次数。	3
Threshold	string	Info 级别的阈值。	90
Statistics	string	Info 级别的统计方法。每个云服务的`Statistics`取值不同。更多信息，请参见云服务监控项。	Average
Warn	object	Warn 级别报警触发条件。
ComparisonOperator	string	Warn 级别阈值的比较符。取值： GreaterThanOrEqualToThreshold：大于等于。 GreaterThanThreshold：大于。 LessThanOrEqualToThreshold：小于等于。 LessThanThreshold：小于。 NotEqualToThreshold：不等于。 GreaterThanYesterday：同比昨天时间上涨。 LessThanYesterday：同比昨天时间下降。 GreaterThanLastWeek：同比上周同一时间上涨。 LessThanLastWeek：同比上周同一时间下降。 GreaterThanLastPeriod：环比上周期上涨。 LessThanLastPeriod：环比上周期下降。	GreaterThanOrEqualToThreshold
Times	integer	Warn 级别的重试次数。	3
Threshold	string	Warn 级别的阈值。	90
Statistics	string	Warn 级别的统计方法。每个云服务的`Statistics`取值不同。更多信息，请参见云服务监控项。	Average
Critical	object	Critical 级别报警触发条件。
ComparisonOperator	string	Critical 级别的阈值比较符。取值： GreaterThanOrEqualToThreshold：大于等于。 GreaterThanThreshold：大于。 LessThanOrEqualToThreshold：小于等于。 LessThanThreshold：小于。 NotEqualToThreshold：不等于。 GreaterThanYesterday：同比昨天时间上涨。 LessThanYesterday：同比昨天时间下降。 GreaterThanLastWeek：同比上周同一时间上涨。 LessThanLastWeek：同比上周同一时间下降。 GreaterThanLastPeriod：环比上周期上涨。 LessThanLastPeriod：环比上周期下降。	GreaterThanOrEqualToThreshold
Times	integer	Critical 级别的重试次数。	5
Threshold	string	Critical 级别的阈值。	90
Statistics	string	Critical 级别的统计方法。每个云服务的`Statistics`取值不同。更多信息，请参见云服务监控项。	Average
Labels	object
Labels	array<object>	报警模板标签。
	object	报警模板的标签。
Key	string	报警模板的标签键。	label1
Value	string	报警模板的标签值。	value1
SilenceTime	integer	通道沉默时间。单位：秒。	3600

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "The specified resource is not found.",
  "RequestId": "8F3A82AD-DA92-52B0-8EC6-C059D1C3839F",
  "Success": true,
  "Resource": {
    "Description": "ECS模板",
    "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"
              }
            ]
          },
          "SilenceTime": 3600
        }
      ]
    }
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	ParameterInvalid	Illegal parameters.
400	%s	%s
412	%s	%s
500	InternalError	The request processing has failed due to some unknown error.
403	AccessForbidden	User not authorized to operate on the specified resource.
404	ResourceNotFound	The specified resource is not found.	未找到指定资源。
409	%s	%s

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。