GetAlertRules - 擷取已經建立的警示規則 - Application Real-Time Monitoring Service

查詢已經建立的警示規則。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

arms:GetAlertRules

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
AlertIds	string	否	警示規則 ID 列表，警示規則 ID 是識別警示規則的唯一標誌，不會重複。如果不指定，API 請求將不會根據警示規則 ID 對警示規則進行篩選。如果指定了警示規則 ID 列表，那麼此次請求將只會返回在列表中的警示規則的子集，其它篩選條件也會同時生效。說明您可以通過其他請求參數調用 GetAlertRules 介面，從返回資訊中擷取 AlertIds，後續您可以直接通過 AlertIds 查詢指定的警示規則。	["12345"]
AlertNames	string	否	警示規則名稱列表。新版警示規則建立時不允許出現重名，但是存量警示規則可能存在重名警示，因此 AlertName 不是警示規則的唯一標誌。如果不指定，將不會對警示規則進行過濾。如果指定警示規則名稱列表，本次請求將只返回在列表中的警示的子集，其它的篩選條件也會生效。	["test"]
RegionId	string	是	地區 ID。	cn-hangzhou
AlertType	string	否	警示規則類型。新版警示必傳。 APPLICATION_MONITORING_ALERT_RULE：應用監控警示規則。 BROWSER_MONITORING_ALERT_RULE：前端監控警示規則。 PROMETHEUS_MONITORING_ALERT_RULE：Prometheus 監控警示規則。	APPLICATION_MONITORING_ALERT_RULE
AlertStatus	string	否	警示規則運行狀態。 RUNNING：運行中 STOPPED：已停止 PAUSED：被暫停說明 PAUSED 狀態說明警示規則狀態異常，被系統主動暫停，可能原因有警示規則唯獨值過大或者關聯集群已經被刪除等。	RUNNING
ClusterId	string	否	Prometheus 監控警示規則的叢集 ID。	ceba9b9ea5b924dd0b6726d2de6******
ProductCode	string	否	無需填寫。	null
Page	integer	是	查詢第 N 頁警示。	1
Size	integer	是	每一頁警示規則數量。	20
Tags	array<object>	否	標籤列表。
	object	否
Key	string	否	標籤鍵。	type
Value	string	否	標籤值。	prod
BizRegionId	string	否	規則所在的地區 ID	cn-hangzhou

返回參數

名稱	類型	描述	樣本值
	object	返回結構體。
RequestId	string	請求 ID。	337B8F7E-0A64-5768-9225-E9B3CF******
PageBean	object	分頁對象。
Total	integer	查詢到的警示規則總數。	1
Page	integer	查詢的頁數。	1
Size	integer	每一頁警示規則數量。	20
AlertRules	array<object>	警示規則列表。
	array<object>	警示規則列表結構體。
AlertId	integer	警示規則 ID。	5730***
AlertName	string	警示規則名稱。	arms-test
UserId	string	阿里雲帳號 ID。	1131971649******
RegionId	string	地區 ID。	cn-hangzhou
AlertType	string	警示規則類型。 APPLICATION_ MONITORING_ ALERT_RULE：應用監控警示規則。 BROWSER_ MONITORING_ ALERT_RULE：前端監控警示規則。 PROMETHEUS_ MONITORING_ ALERT_RULE：Prometheus 監控警示規則。	APPLICATION_MONITORING_ALERT_RULE
AlertStatus	string	警示規則運行狀態。 RUNNING：運行中 STOPPED：已停止 PAUSED：被暫停說明 PAUSED 狀態說明警示規則狀態異常，被系統主動暫停，可能原因有警示規則唯獨值過大或者關聯集群已經被刪除等。	RUNNING
CreatedTime	integer	警示規則建立時間的時間戳記，單位為毫秒。	1640333981000
UpdatedTime	integer	警示規則更新時間的時間戳記，單位為毫秒。	1640333981000
Extend	string	擴充欄位。說明如果是存量應用監控警示規則，欄位會包含連絡人、警示模板、通知內容等資訊。	{\"alarmContext\":\"{\\\"content\\\":\\\"警示名稱:$警示名稱\\\\n篩選條件: $篩選\\\\n警示時間: $警示時間\\\\n警示內容: $警示內容\\\\n注意！：該警示未收到恢複郵件之前，正在持續警示中，24小時後會再次提醒您！\\\",\\\"subTitle\\\":\\\"\\\"}\",\"alertWays\":\"[0,1]\",\"contactGroupIds\":\"381,5075\",\"notice\":\"{\\\"endTime\\\":1480607940000,\\\"noticeEndTime\\\":1480607940000,\\\"noticeStartTime\\\":1480521600000,\\\"startTime\\\":1480521600000}\"}
NotifyStrategy	string	通知策略名稱稱。	ALERT_MANAGER
Pids	array	應用監控或前端監控警示關聯應用的 PID。
	string	應用的 PID。	["b590lhguqs@40d8deedfa9******"]
AutoAddNewApplication	boolean	應用監控或前端監控是否開啟新建立應用追加到此警示規則功能。 `true`：開啟 `false`：不開啟	false
MetricsType	string	應用監控或前端監控警示規則的警示指標類型。	JVM
AlertRuleContent	object	應用監控或前端監控的警示規則內容。
Condition	string	應用監控或前端監控多個警示條件之間的觸發邏輯。 OR：滿足下述任何一個條件。 AND：同時滿足下述條件。	OR
AlertRuleItems	array<object>	應用監控或前端監控警示規則的警示條件。
	object	警示條件對象。
N	integer	最近 N 分鐘。	1
MetricKey	string	具體警示條件的指標。	appstat.jvm.non_heap_used
Aggregate	string	警示條件彙總方式。 AVG：平均 SUM：求和 MAX：最大值 MIN：最小值	AVG
Operator	string	警示條件的判斷條件。 CURRENT_GTE：大於或等於 CURRENT_LTE：小於或等於 PREVIOUS_UP：環比上升百分比 PREVIOUS_DOWN：環比下降百分比 HOH_UP：與上小時同比上升百分比 HOH_DOWN：與上小時同比下降百分比 DOD_UP：與昨日同比上升百分比 DOD_DOWN：與昨日同比下降百分比	CURRENT_GTE
Value	string	警示條件閾值。	1
Filters	object	應用監控或前端監控警示規則的過濾項。
DimFilters	array<object>	應用監控或前端監控警示規則的過濾項資訊。
	object	應用監控或前端監控警示規則的過濾條件對象。
FilterKey	string	過濾條件 Key。	rootIp
FilterOpt	string	過濾條件操作關係。	ALL
FilterValues	array	過濾條件參數資訊。
	string	過濾條件參數。	null
CustomSLSFilters	array<object>	前端監控警示規則的自訂過濾條件。
	object	自訂過濾條件對象。
Key	string	過濾條件 Key。	username
Opt	string	過濾條件操作關係。 =：等於 not：不等於	=
Value	string	過濾條件參數值。	test
T	string	僅用於區分前端監控日誌類型，其它過濾條件不包含此欄位。	null
Show	boolean	此篩選條件是否在前端展示。	false
CustomSLSGroupByDimensions	array	彙總維度資訊。
	string	彙總維度參數值。	["page"]
CustomSLSWheres	array	設定篩選條件資訊。
	string	設定篩選條件參數值。	["t like '%api%'"]
AlertCheckType	string	Prometheus 監控警示規則的警示檢查類型。 STATIC：靜態閾實值型別。 CUSTOM：自訂 PromQL 類型。	STATIC
ClusterId	string	Prometheus 監控警示規則的叢集 ID。	ceba9b9ea5b924dd0b6726d2de6******
AlertGroup	integer	Prometheus 警示規則的警示分組 ID。 -1：自訂 PromQL 1：Kubernetes 負載 15：Kubernetes 節點	1
PromQL	string	Prometheus 警示規則的 PromQL 語句。	node_memory_MemAvailable_bytes{} / node_memory_MemTotal_bytes{} * 100
Duration	string	Prometheus 警示規則的期間。	1
Level	string	Prometheus 警示規則的等級。 P1：一般用於影響核心業務可用性，影響範圍很大，可能導致嚴重後果的重大問題的警示通知。 P2：一般用於部分業務出錯，會對系統可用性造成一定影響，但是影響範圍相對有限的問題的警示通知。 P3：一般用於對可能導致業務出錯或者受影響的問題的警示通知，或者在相對重要程度較低的業務發送的警示通知。 P4：用於需要通知，但是優先順序較低，也不會對業務造成影響的情境發送警示通知。預設：如果不需要區分警示等級，可以使用預設層級。	P2
Message	string	Prometheus 警示規則的警示內容。	命名空間: {{$labels.namespace}} / Pod: {{$labels.pod_name}} / 容器: {{$labels.container}} CPU使用率{{$labels.metrics_params_opt_label_value}} {{$labels.metrics_params_value}}%, 當前值{{ printf "%.2f" $value }}%
Labels	array<object>	Prometheus 警示規則的標籤。
	object	標籤結構體。
Name	string	標籤鍵。	123
Value	string	標籤值。	abc
Annotations	array<object>	Prometheus 警示規則的注釋。
	object	注釋結構體。
Name	string	注釋鍵。	123
Value	string	注釋值。	abc
Tags	array<object>	警示規則標籤。
	object
Key	string	標籤鍵。	type
Value	string	標籤值。	prod

樣本

正常返回樣本

JSON格式

{
  "RequestId": "337B8F7E-0A64-5768-9225-E9B3CF******",
  "PageBean": {
    "Total": 1,
    "Page": 1,
    "Size": 20,
    "AlertRules": [
      {
        "AlertId": 0,
        "AlertName": "arms-test",
        "UserId": "1131971649******",
        "RegionId": "cn-hangzhou",
        "AlertType": "APPLICATION_MONITORING_ALERT_RULE",
        "AlertStatus": "RUNNING",
        "CreatedTime": 1640333981000,
        "UpdatedTime": 1640333981000,
        "Extend": "{\\\"alarmContext\\\":\\\"{\\\\\\\"content\\\\\\\":\\\\\\\"警示名稱:$警示名稱\\\\\\\\n篩選條件: $篩選\\\\\\\\n警示時間: $警示時間\\\\\\\\n警示內容: $警示內容\\\\\\\\n注意！：該警示未收到恢複郵件之前，正在持續警示中，24小時後會再次提醒您！\\\\\\\",\\\\\\\"subTitle\\\\\\\":\\\\\\\"\\\\\\\"}\\\",\\\"alertWays\\\":\\\"[0,1]\\\",\\\"contactGroupIds\\\":\\\"381,5075\\\",\\\"notice\\\":\\\"{\\\\\\\"endTime\\\\\\\":1480607940000,\\\\\\\"noticeEndTime\\\\\\\":1480607940000,\\\\\\\"noticeStartTime\\\\\\\":1480521600000,\\\\\\\"startTime\\\\\\\":1480521600000}\\\"}",
        "NotifyStrategy": "ALERT_MANAGER",
        "Pids": [
          "[\"b590lhguqs@40d8deedfa9******\"]"
        ],
        "AutoAddNewApplication": false,
        "MetricsType": "JVM",
        "AlertRuleContent": {
          "Condition": "OR",
          "AlertRuleItems": [
            {
              "N": 1,
              "MetricKey": "appstat.jvm.non_heap_used",
              "Aggregate": "AVG",
              "Operator": "CURRENT_GTE",
              "Value": "1"
            }
          ]
        },
        "Filters": {
          "DimFilters": [
            {
              "FilterKey": "rootIp",
              "FilterOpt": "ALL",
              "FilterValues": [
                "null"
              ]
            }
          ],
          "CustomSLSFilters": [
            {
              "Key": "username",
              "Opt": "=",
              "Value": "test",
              "T": "null",
              "Show": false
            }
          ],
          "CustomSLSGroupByDimensions": [
            "[\"page\"]"
          ],
          "CustomSLSWheres": [
            "[\"t like '%api%'\"]"
          ]
        },
        "AlertCheckType": "STATIC",
        "ClusterId": "ceba9b9ea5b924dd0b6726d2de6******",
        "AlertGroup": 1,
        "PromQL": "node_memory_MemAvailable_bytes{} / node_memory_MemTotal_bytes{} * 100",
        "Duration": "1",
        "Level": "P2",
        "Message": "命名空間: {{$labels.namespace}} / Pod: {{$labels.pod_name}} / 容器: {{$labels.container}} CPU使用率{{$labels.metrics_params_opt_label_value}} {{$labels.metrics_params_value}}%, 當前值{{ printf \"%.2f\" $value }}%",
        "Labels": [
          {
            "Name": "123",
            "Value": "abc"
          }
        ],
        "Annotations": [
          {
            "Name": "123",
            "Value": "abc"
          }
        ],
        "Tags": [
          {
            "Key": "type",
            "Value": "prod"
          }
        ]
      }
    ]
  }
}

錯誤碼

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

變更歷史

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