全部產品
Search

搜尋本產品

    Cloud Monitor：PutGroupMetricRule

    文件中心

    Cloud Monitor：PutGroupMetricRule

    更新時間：Jun 26, 2026

    呼叫PutGroupMetricRule介面建立或修改指定應用分組中的報警規則。

    介面說明

    本文將提供一個示例，為應用分組17285****中的雲端伺服器 ECS 的監控項cpu_total建立一條報警規則，其中報警規則的 ID 為123456，報警規則名稱為Rule_test，報警級別為Critical，報警統計方法為Average，報警閾值比較符為GreaterThanOrEqualToThreshold，報警閾值為90，報警重試次數為3。返回結果顯示，建立報警規則成功，報警規則 ID 為123456。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    cms:PutGroupMetricRule

    create

    *GroupMetricRule

    acs:cms::{#accountId}:group/{#groupId}

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    GroupId

    string

    是

    應用分組 ID。

    關於如何取得應用分組 ID，請參見 DescribeMonitorGroups 。

    17285****
    RuleId

    string

    是

    報警規則 ID。

    • 當您為該應用分組建立報警規則時，直接輸入報警規則 ID。

    • 當您修改該應用分組中的指定報警規則時，需要取得報警規則 ID。關於如何取得報警規則 ID，請參見 DescribeMetricRuleList 。

    123456
    Category

    string

    否

    雲端產品名稱縮寫。

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

    ECS
    RuleName

    string

    是

    報警規則名稱。

    • 當您為該應用分組建立報警規則時，直接輸入報警規則名稱。

    • 當您修改該應用分組中的指定報警規則時，需要取得報警規則名稱。關於如何取得報警規則名稱，請參見 DescribeMetricRuleList 。

    Rule_01
    Namespace

    string

    是

    雲端產品的命名空間。

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

    acs_ecs_dashboard
    MetricName

    string

    是

    監控項名稱。

    關於如何取得監控項名稱，請參見 DescribeMetricMetaList 或雲端產品監控項。

    cpu_total
    Dimensions

    string

    否

    應用分組中報警規則的第一級維度。

    格式：key:value鍵值對形式的集合，例如：{"userId":"120886317861****"}和{"instanceId":"i-m5e1qg6uo38rztr4****"}。

    [{"instanceId":"i-m5e1qg6uo38rztr4****"}]
    ExtraDimensionJson

    string

    否

    應用分組中報警規則的第二級或第三級維度。

    格式：key:value鍵值對形式的集合，例如：port:80、/dev/xvda:d-m5e6yphgzn3aprwu****。

    當報警規則的第一級維度為{"instanceId":"i-m5e1qg6uo38rztr4****"}時，其第二級維度為該執行個體中的雲端硬碟{"/dev/xvda":"d-m5e6yphgzn3aprwu****"}。

    {"/dev/xvda":"d-m5e6yphgzn3aprwu****"}
    EffectiveInterval

    string

    否

    報警規則的生效時間範圍。

    05:31-23:59
    NoEffectiveInterval

    string

    否

    報警規則的失效時間範圍。

    00:00-05:30
    SilenceTime

    integer

    否

    通道沉默週期。

    單位：秒。預設值：86400。

    86400
    Period

    string

    否

    監控資料的上報週期。

    Period的取值為 60 或 60 的整數倍。單位：秒。預設值：300。

    60
    Interval

    string

    否

    報警規則的探測週期。單位：秒。

    說明

    建議報警規則的探測週期和資料上報週期保持一致。如果報警規則的探測週期小於資料上報週期，會因為資料不足而不能觸發報警。

    60
    Webhook

    string

    否

    報警發生回呼時的 URL 地址。

    填寫公網可存取的 URL 地址，雲端監控會將報警資訊通過 POST 請求推送到該地址，目前僅支援 HTTP 協議。

    https://www.aliyun.com
    EmailSubject

    string

    否

    報警郵件主題。

    ECS instance
    ContactGroups

    string

    否

    報警聯繫組。

    ECS_Group
    Escalations.Critical.Statistics

    string

    否

    Critical 級別報警統計方法。多個統計方法之間用半形逗號（,）分隔。

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

    Average
    Escalations.Critical.ComparisonOperator

    string

    否

    Critical 級別閾值比較符。取值：

    • GreaterThanOrEqualToThreshold：大於等於。

    • GreaterThanThreshold：大於。

    • LessThanOrEqualToThreshold：小於等於。

    • LessThanThreshold：小於。

    • NotEqualToThreshold：不等於。

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

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

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

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

    • GreaterThanLastPeriod：環比上週期上漲。

    • LessThanLastPeriod：環比上週期下降。

    GreaterThanOrEqualToThreshold
    Escalations.Critical.Threshold

    string

    否

    Critical 級別報警閾值。

    90
    Escalations.Critical.Times

    integer

    否

    Critical 級別報警重試次數。

    3
    Escalations.Warn.Statistics

    string

    否

    Warn 級別報警統計方法。多個統計方法之間用半形逗號（,）分隔。

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

    Average
    Escalations.Warn.ComparisonOperator

    string

    否

    Warn 級別閾值比較符。取值：

    • GreaterThanOrEqualToThreshold：大於等於。

    • GreaterThanThreshold：大於。

    • LessThanOrEqualToThreshold：小於等於。

    • LessThanThreshold：小於。

    • NotEqualToThreshold：不等於。

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

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

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

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

    • GreaterThanLastPeriod：環比上週期上漲。

    • LessThanLastPeriod：環比上週期下降。

    GreaterThanOrEqualToThreshold
    Escalations.Warn.Threshold

    string

    否

    Warn 級別報警閾值。

    90
    Escalations.Warn.Times

    integer

    否

    Warn 級別報警重試次數。

    3
    Escalations.Info.Statistics

    string

    否

    Info 級別報警統計方法。多個統計方法之間用半形逗號（,）分隔。

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

    Average
    Escalations.Info.ComparisonOperator

    string

    否

    Info 級別閾值比較符。取值：

    • GreaterThanOrEqualToThreshold：大於等於。

    • GreaterThanThreshold：大於。

    • LessThanOrEqualToThreshold：小於等於。

    • LessThanThreshold：小於。

    • NotEqualToThreshold：不等於。

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

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

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

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

    • GreaterThanLastPeriod：環比上週期上漲。

    • LessThanLastPeriod：環比上週期下降。

    GreaterThanOrEqualToThreshold
    Escalations.Info.Threshold

    string

    否

    Info 級別報警閾值。

    90
    Escalations.Info.Times

    integer

    否

    Info 級別報警重試次數。

    3
    NoDataPolicy

    string

    否

    無監控資料時報警的處理方式。取值：

    • KEEP_LAST_STATE（預設值）：不做任何處理。

    • INSUFFICIENT_DATA：報警內容為無資料。

    • OK：正常。

    KEEP_LAST_STATE
    Labels

    array<object>

    否

    報警規則標籤。

    報警通知中會包含標籤。

    object

    否

    無。

    Key

    string

    否

    報警規則的標籤鍵。

    key1
    Value

    string

    否

    報警規則的標籤值。

    value1
    Options

    string

    否

    進階設定。

    格式：{"key1":"value1","key2":"value2"}，例如：{"NotSendOK":true}，表示是否傳送報警恢復通知，key 為 NotSendOK，value 為 true（不傳送）或 false（預設傳送）。

    {"NotSendOK":true}

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

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    無。

    Code

    string

    狀態碼。

    說明

    200 表示成功。

    200
    Message

    string

    報錯資訊。

    The Request is not authorization.
    RequestId

    string

    請求 ID。

    461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D
    Success

    boolean

    操作是否成功。取值：

    • true：成功。

    • false：失敗。

    true
    Result

    object

    建立或修改報警規則的結果。

    RuleId

    string

    報警規則 ID。

    123456

    樣本

    正常返回樣本

    JSON格式

    {
  "Code": "200",
  "Message": "The Request is not authorization.",
  "RequestId": "461CF2CD-2FC3-4B26-8645-7BD27E7D0F1D",
  "Success": true,
  "Result": {
    "RuleId": "123456"
  }
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 %s %s
    499 %s %s
    500 %s %s
    204 %s %s
    403 %s %s
    206 %s %s
    404 %s %s
    503 %s %s
    406 %s %s

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

    變更歷史

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