调用ListAlerts API列出告警规则-日志服务-阿里云

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

GET /alerts HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
offset	integer	否	查询开始行。默认值为 0。	0
size	integer	否	分页查询时，设置的每页行数。最大值为 200。默认值为 10。	10
logstore	string	否	获取指定 Logstore 下的告警规则。默认值为空。	ali-test-logstore

返回参数

名称	类型	描述	示例值
headers	object
Server	string		nginx
Content-Type	string		application/json
Content-Length	string		0
Connection	string		close
Date	string		Sun, 27 May 2018 08:25:04 GMT
x-log-requestid	string		5B0A6B60BB6EE39764D458B5
	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": "Cron",
        "cronExpression": "0/5 * * * *",
        "runImmediately": false,
        "timeZone": "+0800",
        "delay": 4,
        "interval": "1m"
      },
      "createTime": 0,
      "lastModifiedTime": 0,
      "status": "ENABLED/DISABLED"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。