調用ListAlerts API列出警示規則-Log Service-阿里雲 - Simple Log Service

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

log:ListAlerts

list

*全部資源

*

無

請求文法

GET /alerts HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
project	string	是	Project 名稱	ali-test-project
offset	integer	否	查詢開始行。預設值為 0。	0
size	integer	否	分頁查詢時，設定的每頁行數。最大值為 200。預設值為 10。	10
logstore	string	否	擷取指定 Logstore 下的警示規則。預設值為空白。	ali-test-logstore

返回參數

名稱	類型	描述	樣本值
	object
total	integer	Project 下警示總數量	80
count	integer	當前返回的警示數量	10
results	array	警示配置結果清單
	Alert	警示配置

樣本

正常返回樣本

JSON格式

{
  "total": 80,
  "count": 10,
  "results": [
    {
      "name": "alert-123456",
      "displayName": "alertNameExample",
      "description": "Alert Desc",
      "configuration": {
        "muteUntil": 1698907508,
        "version": "2.0",
        "type": "default",
        "templateConfiguration": {
          "id": "sls.app.ack.ip.not_enough",
          "type": "sys",
          "version": "1",
          "lang": "cn",
          "tokens": {
            "test": "test",
            "test2": 1
          },
          "aonotations": {
            "test": "test",
            "test2": 1
          }
        },
        "dashboard": "DasnboardExample",
        "threshold": 1,
        "noDataFire": false,
        "noDataSeverity": 6,
        "sendResolved": false,
        "queryList": [
          {
            "chartTitle": "chartExmaple",
            "query": "* | select *",
            "timeSpanType": "Relative",
            "start": "-5m",
            "end": "now",
            "storeType": "log",
            "project": "projectExample",
            "store": "store Example",
            "region": "cn-hangzhou",
            "roleArn": "",
            "dashboardId": "dashboardExample",
            "powerSqlMode": "auto",
            "ui": ""
          }
        ],
        "annotations": [
          {
            "key": "title",
            "value": "example value"
          }
        ],
        "labels": [
          {
            "key": "title",
            "value": "example value"
          }
        ],
        "conditionConfiguration": {
          "condition": "cnt > 100",
          "countCondition": "__count__ > 5"
        },
        "severityConfigurations": [
          {
            "severity": 8,
            "evalCondition": {
              "condition": "cnt > 100",
              "countCondition": "__count__ > 5"
            }
          }
        ],
        "joinConfigurations": [
          {
            "type": "left_join",
            "condition": "$0.id == $1.id"
          }
        ],
        "groupConfiguration": {
          "type": "custom",
          "fields": [
            "id"
          ]
        },
        "policyConfiguration": {
          "alertPolicyId": "sls.builtin.dynamic",
          "actionPolicyId": "example_action_policy",
          "repeatInterval": "10m"
        },
        "autoAnnotation": false,
        "sinkEventStore": {
          "enabled": true,
          "endpoint": "cn-shanghai-intranet.log.aliyuncs.com",
          "project": "exampleProject",
          "eventStore": "exampleStore",
          "roleArn": "acs:ram::123456789:role/aliyunlogetlrole"
        },
        "sinkCms": {
          "enabled": true
        },
        "sinkAlerthub": {
          "enabled": true
        },
        "tags": [
          "host"
        ]
      },
      "schedule": {
        "type": "FixedRate",
        "cronExpression": "0/5 * * * *",
        "runImmediately": false,
        "timeZone": "+0800",
        "delay": 4,
        "interval": "60s"
      },
      "createTime": 1695090077,
      "lastModifiedTime": 1714274900,
      "status": "ENABLED/DISABLED"
    }
  ]
}

錯誤碼

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

變更歷史

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