調用DescribeMetricRuleTemplateAttribute查詢警示模板詳情-CloudMonitor-阿里雲 - Cloud Monitor

呼叫DescribeMetricRuleTemplateAttribute介面查詢報警範本詳情。

介面說明

本文將提供一個示例，查詢報警範本70****的詳情。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

cms:DescribeMetricRuleTemplateAttribute

get

*All Resource

*

無

請求參數

名稱	類型	必填	描述	樣本值
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 template
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 template",
    "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

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。