全部產品
Search

搜尋本產品

    Cloud Monitor：CreateMetricRuleTemplate - 建立警示模板

    文件中心

    Cloud Monitor：CreateMetricRuleTemplate - 建立警示模板

    更新時間：Mar 21, 2026

    調用CreateMetricRuleTemplate介面建立警示模板。

    調試

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

    調試

    授權資訊

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

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    cms:CreateMetricRuleTemplate

    create

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    Name

    string

    是

    警示模板名稱。

    Template1
    Description

    string

    否

    警示模板描述資訊。

    ECS_Template1
    AlertTemplates

    array<object>

    否

    警示模板列表。

    object

    否

    警示模板。

    Escalations.Info.Threshold

    string

    否

    普通層級警示閾值。

    N 的取值範圍：1~200。

    說明

    警示層級 Critical（嚴重）、Warn（警告）或 Info（資訊）至少設定一個，且該警示層級中的參數 Statistics、ComparisonOperator、Threshold 和 Times 必須同時設定。

    20
    MetricName

    string

    是

    監控項名稱。

    N 的取值範圍：1~200。

    關於如何擷取監控項，請參見 DescribeMetricMetaList 或雲產品監控項。

    cpu_total
    Webhook

    string

    否

    警示發生回調時的 URL 地址。

    N 的取值範圍：1~200。

    填寫公網可訪問的 URL 地址，CloudMonitor會將警示資訊通過 POST 請求推送到該地址，目前僅支援 HTTP 協議。

    http://ww.aliyun.com
    Escalations.Warn.Threshold

    string

    否

    警告層級警示閾值。

    N 的取值範圍：1~200。

    說明

    警示層級 Critical（嚴重）、Warn（警告）或 Info（資訊）至少設定一個，且該警示層級中的參數 Statistics、ComparisonOperator、Threshold 和 Times 必須同時設定。

    30
    Namespace

    string

    是

    雲產品的資料命名空間。

    N 的取值範圍：1~200。

    關於如何擷取雲產品的資料命名空間，請參見 DescribeMetricMetaList 或雲產品監控項。

    acs_ecs_dashboard
    Period

    integer

    否

    監控資料的彙總周期。單位：秒。

    預設為監控項對應的最小周期，通常不需要指定。

    N 的取值範圍：1~200。

    60
    RuleName

    string

    是

    警示規則名稱。

    N 的取值範圍：1~200。

    ECS_Rule1
    Escalations.Critical.Times

    integer

    否

    發送緊急警示通知需要監控指標達到警示閾值的次數。

    N 的取值範圍：1~200。

    說明

    警示層級 Critical（嚴重）、Warn（警告）或 Info（資訊）至少設定一個，且該警示層級中的參數 Statistics、ComparisonOperator、Threshold 和 Times 必須同時設定。

    3
    Selector

    string

    否

    Dimension 擴充欄位的選項。

    N 的取值範圍：1~200。

    例如：警示模板被應用到了一個應用分組中，當該參數設定為{"disk":"/"}，監控項（MetricName）設定為DiskUtilization時，表示關聯警示模板的應用分組中所有執行個體的磁碟根分區（"/") 被關聯到了對應警示規則中。

    說明

    關於擴充欄位選項的取值，請參見 DescribeMetricRuleTemplateAttribute 。

    {"disk":"/"}
    Escalations.Info.Statistics

    string

    否

    普通層級警示統計方法。

    N 的取值範圍：1~200。

    該參數的取值由指定雲產品的MetricName對應的Statistics列決定，例如：Maximum、Minimum 和 Average。關於如何擷取該參數的取值，請參見雲產品監控項。

    說明

    警示層級 Critical（嚴重）、Warn（警告）或 Info（資訊）至少設定一個，且該警示層級中的參數 Statistics、ComparisonOperator、Threshold 和 Times 必須同時設定。

    Average
    Escalations.Warn.Times

    integer

    否

    發送警告警示通知需要監控指標達到警示閾值的次數。

    N 的取值範圍：1~200。

    說明

    警示層級 Critical（嚴重）、Warn（警告）或 Info（資訊）至少設定一個，且該警示層級中的參數 Statistics、ComparisonOperator、Threshold 和 Times 必須同時設定。

    1
    Escalations.Info.ComparisonOperator

    string

    否

    普通層級閾值比較符。取值：

    • GreaterThanOrEqualToThreshold：大於等於。

    • GreaterThanThreshold：大於。

    • LessThanOrEqualToThreshold：小於等於。

    • LessThanThreshold：小於。

    • NotEqualToThreshold：不等於。

    • GreaterThanYesterday：同比昨天時間上漲。

    • LessThanYesterday：同比昨天時間下降。

    • GreaterThanLastWeek：同比上周同一時間上漲。

    • LessThanLastWeek：同比上周同一時間下降。

    • GreaterThanLastPeriod：環比上周期上漲。

    • LessThanLastPeriod：環比上周期下降。

    N 的取值範圍：1~200。

    說明

    警示層級 Critical（嚴重）、Warn（警告）或 Info（資訊）至少設定一個，且該警示層級中的參數 Statistics、ComparisonOperator、Threshold 和 Times 必須同時設定。

    GreaterThanOrEqualToThreshold
    Category

    string

    是

    雲產品名稱縮寫。

    N 的取值範圍：1~200。

    關於如何擷取雲產品名稱縮寫，請參見 DescribeProjectMeta 介面的返回參數Labels中的metricCategory。

    ecs
    Escalations.Critical.Threshold

    string

    否

    觸發緊急層級警示通知的閾值。

    N 的取值範圍：1~200。

    說明

    警示層級 Critical（嚴重）、Warn（警告）或 Info（資訊）至少設定一個，且該警示層級中的參數 Statistics、ComparisonOperator、Threshold 和 Times 必須同時設定。

    30
    Escalations.Critical.Statistics

    string

    否

    緊急層級警示統計方法。

    N 的取值範圍：1~200。

    該參數的取值由指定雲產品的MetricName對應的Statistics列決定，例如：Maximum、Minimum 和 Average。關於如何擷取該參數的取值，請參見雲產品監控項。

    說明

    警示層級 Critical（嚴重）、Warn（警告）或 Info（資訊）至少設定一個，且該警示層級中的參數 Statistics、ComparisonOperator、Threshold 和 Times 必須同時設定。

    Average
    Escalations.Critical.ComparisonOperator

    string

    否

    緊急層級閾值比較符。取值：

    • GreaterThanOrEqualToThreshold：大於等於。

    • GreaterThanThreshold：大於。

    • LessThanOrEqualToThreshold：小於等於。

    • LessThanThreshold：小於。

    • NotEqualToThreshold：不等於。

    • GreaterThanYesterday：同比昨天時間上漲。

    • LessThanYesterday：同比昨天時間下降。

    • GreaterThanLastWeek：同比上周同一時間上漲。

    • LessThanLastWeek：同比上周同一時間下降。

    • GreaterThanLastPeriod：環比上周期上漲。

    • LessThanLastPeriod：環比上周期下降。

    N 的取值範圍：1~200。

    說明

    警示層級 Critical（嚴重）、Warn（警告）或 Info（資訊）至少設定一個，且該警示層級中的參數 Statistics、ComparisonOperator、Threshold 和 Times 必須同時設定。

    GreaterThanOrEqualToThreshold
    Escalations.Warn.ComparisonOperator

    string

    否

    警告層級閾值比較符。取值：

    • GreaterThanOrEqualToThreshold：大於等於。

    • GreaterThanThreshold：大於。

    • LessThanOrEqualToThreshold：小於等於。

    • LessThanThreshold：小於。

    • NotEqualToThreshold：不等於。

    • GreaterThanYesterday：同比昨天時間上漲。

    • LessThanYesterday：同比昨天時間下降。

    • GreaterThanLastWeek：同比上周同一時間上漲。

    • LessThanLastWeek：同比上周同一時間下降。

    • GreaterThanLastPeriod：環比上周期上漲。

    • LessThanLastPeriod：環比上周期下降。

    N 的取值範圍：1~200。

    說明

    警示層級 Critical（嚴重）、Warn（警告）或 Info（資訊）至少設定一個，且該警示層級中的參數 Statistics、ComparisonOperator、Threshold 和 Times 必須同時設定。

    GreaterThanOrEqualToThreshold
    Escalations.Info.Times

    integer

    否

    發送普通警示通知需要監控指標達到警示閾值的次數。

    N 的取值範圍：1~200。

    說明

    警示層級 Critical（嚴重）、Warn（警告）或 Info（資訊）至少設定一個，且該警示層級中的參數 Statistics、ComparisonOperator、Threshold 和 Times 必須同時設定。

    1
    Escalations.Warn.Statistics

    string

    否

    警告層級警示統計方法。

    N 的取值範圍：1~200。

    該參數的取值由指定雲產品的MetricName對應的Statistics列決定，例如：Maximum、Minimum 和 Average。關於如何擷取該參數的取值，請參見雲產品監控項。

    說明

    警示層級 Critical（嚴重）、Warn（警告）或 Info（資訊）至少設定一個，且該警示層級中的參數 Statistics、ComparisonOperator、Threshold 和 Times 必須同時設定。

    Average

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回資料。

    Code

    integer

    狀態代碼。

    說明

    200 表示成功。

    200
    Message

    string

    錯誤資訊。

    The Request is not authorization.
    RequestId

    string

    請求 ID。

    9763ED1A-4D09-41BF-851E-310421750204
    Success

    boolean

    操作是否成功。取值：

    • true：成功。

    • false：失敗。

    true
    Id

    integer

    警示模板 ID。

    12345

    樣本

    正常返回樣本

    JSON格式

    {
  "Code": 200,
  "Message": "The Request is not authorization.",
  "RequestId": "9763ED1A-4D09-41BF-851E-310421750204",
  "Success": true,
  "Id": 12345
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidQueryParameter %s
    401 AccessDeniedException You donot have sufficient access to perform this action.
    412 ResourcesOverLimit Resources over limit.
    500 InternalFailure %s
    402 LimitExceeded The quota for this customer had been reached.
    403 InvalidClientTokenId not allow this operation. 沒有許可權
    206 %s %s
    503 %s %s
    406 %s %s
    429 Throttli∂ngException The request was denied due to request throttling.
    409 %s %s
    409 ResourceConflict Concurrent modification of resources.
    409 ResourceExist Resources already exist.

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

    變更歷史

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