調用DescribeMetricRuleTemplateList查詢警示模板列表-CloudMonitor-阿里雲

調用DescribeMetricRuleTemplateList介面查詢警示模板列表。

介面說明

本文將提供一個樣本，查詢警示模板列表。返回結果顯示，警示模板列表中共有 2 個警示模板，分別是ECS_Template1和ECS_Template2。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

cms:DescribeMetricRuleTemplateList

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
Name	string	否	警示模板名稱。	ECS_Template1
Keyword	string	否	警示模板名稱關鍵字。	ECS
TemplateId	integer	否	警示模板 ID。	70****
PageNumber	integer	否	頁碼。預設值：1。	1
PageSize	integer	否	每頁顯示模板的記錄條數。	10
History	boolean	否	是否顯示警示模板應用到應用分組的記錄。取值： true：顯示。 false（預設值）：不顯示。	false
Order	boolean	否	排序方式。取值： true（預設值）：升序。 false：降序。	true
OrderBy	string	否	排序依據。取值： gmtMotified：修改日期。 gmtCreate（預設值）：建立日期。	gmtCreate

關於公用請求參數的詳情，請參見公用參數。

返回參數

名稱	類型	描述	樣本值
	object
Code	integer	狀態代碼。說明 200 表示成功。	200
Message	string	錯誤資訊。	The Request is not authorization.
RequestId	string	請求 ID。	659401C0-6214-5C02-972A-CFA929D717B7
Total	integer	總記錄條數。	2
Success	boolean	操作是否成功。取值： true：成功。 false：失敗。	true
Templates	object
Template	array<object>	警示模板列表。
	array<object>	無。
Description	string	警示模板描述資訊。	ECS的CPU使用率
GmtCreate	integer	建立警示模板的時間戳記。單位：毫秒。	1646018798000
Name	string	警示模板名稱。	ECS_Template1
RestVersion	integer	警示模板版本。預設值：0。	0
GmtModified	integer	修改警示模板的時間戳記。單位：毫秒。	1646054798000
TemplateId	integer	警示模板 ID。	70****
ApplyHistories	object
ApplyHistory	array<object>	警示模板應用到應用分組的記錄。
	object	無。
GroupId	integer	應用分組 ID。	3607****
GroupName	string	應用分組名稱。	ECS_Group
ApplyTime	integer	警示模板應用到應用分組的時間戳記。單位：毫秒。	1646055898000

樣本

正常返回樣本

JSON格式

{
  "Code": 200,
  "Message": "The Request is not authorization.",
  "RequestId": "659401C0-6214-5C02-972A-CFA929D717B7",
  "Total": 2,
  "Success": true,
  "Templates": {
    "Template": [
      {
        "Description": "ECS的CPU使用率",
        "GmtCreate": 1646018798000,
        "Name": "ECS_Template1",
        "RestVersion": 0,
        "GmtModified": 1646054798000,
        "TemplateId": 0,
        "ApplyHistories": {
          "ApplyHistory": [
            {
              "GroupId": 0,
              "GroupName": "ECS_Group",
              "ApplyTime": 1646055898000
            }
          ]
        }
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	ParameterInvalid	Illegal parameters.
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.	未找到指定資源。

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

變更歷史

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