You need to enable JavaScript to run this app.
导航
获取所有告警记录
最近更新时间:2024.03.19 20:35:15首次发布时间:2023.07.28 15:16:37

本接口支持获取指定时间段内的告警通知记录及详细信息。

注意事项

  • 请求频率:单用户请求频率限制为 10 次/秒

  • 超时时间:超时时间约 5 秒

  • 历史数据查询时间范围:近 90 天

请求说明

  • 请求方式:POST

  • 请求地址:https://imagex.volcengineapi.com/Action=GetImageAlertRecords&Version=2018-08-01

说明

veImageX 在全球多个区域部署,每个区域有自己对应的 OpenAPI 域名,不支持跨区域调用。具体详情请查看服务地址

请求参数

以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共参数

参数类型是否必选示例值描述
Content-TypeStringapplication/json请求头字段

Query

参数类型是否必选示例值描述
ActionStringGetImageAlertRecords接口名称。当前 API 的名称为 GetImageAlertRecords
VersionString2018-08-01接口版本。当前 API 的版本为 2018-08-01

Body

参数类型是否必选示例值描述
NameString/test/告警名称,正则匹配。不填则查询所有告警记录。
RuleIdStringR1ae373c0-0686-48b5-bf6f-84d529c55881告警规则 ID,完全匹配。不填则查询所有告警记录。
AppIdString78**23应用 ID。您可以通过调用 GetImageXQueryApps 的方式获取账号下全部的 AppId。

StartTime

String

2019-06-02T00:00:00+08:00

获取数据起始时间点。日期格式按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如 2019-06-02T00:00:00+08:00

说明

由于仅支持查询近 90 天的历史数据,则若此刻时间为2011-11-21T16:14:00+08:00,那么您可输入最早的开始时间为2011-08-18T00:00:00+08:00

EndTimeString2019-06-02T01:00:00+08:00获取数据结束时间点,需在起始时间点之后。日期格式按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如 2019-06-02T00:00:00+08:00
LimitInteger10获取个数限制。默认值为 10,取值范围为 (0,100]。
MarkerString0分页偏移量。默认值为 0,表示从最新一个开始获取。

返回参数

参数类型示例值描述
TotalInteger1记录总数

HasMore

Bool

false

是否有更多记录,取值如下所示:

  • true:是
  • false:否
AlertRecordsArray of AlertRecords告警记录列表

AlertRecords

参数类型示例值描述
RuleIdStringR1ae373c0-0686-48b5-bf6f-84d529c55881告警规则 ID
NameStringtest告警规则名称

Phase

String

upload

告警阶段,取值如下所示:

  • upload:图片上传-上传 1.0
  • uploadv2:图片上传-上传 2.0
  • cdn:图片加载-下行网络监控
  • client:图片加载-客户端传状态监控
  • sensible:图片加载-感知指标监控
  • exceed:图片加载-大图指标
OSStringiOS告警平台

Level

String

warn

告警级别,取值如下所示:

  • warn:警告
  • error:错误
  • fatal:致命
AlertAtString2019-06-02T00:00:00+08:00告警时间。日期格式按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm
MarkerString1记录标识,用于获取下一页数据。
AlertCondJSON Object告警条件,具体请见 AlertCond

AlertCond

参数类型示例值描述

LogicOp

String

or

规则之间的逻辑关系,取值如下所示:

  • and:和
  • or:或
AlertContentArray of AlertContent各指标告警信息

AlertContent

参数类型示例值描述
ItemStringcdn_srate指标名称

Func

String

avg

指标取值函数,取值如下所示:

  • max:最大值
  • min:最小值
  • avg:平均值
  • pct25:25峰值
  • pct50:50峰值
  • pct90:90峰值
  • pct99:99峰值
  • sum:总和

Op

String

LE

指标比较方法,取值如下所示:

  • LE:小于等于
  • GE:大于等于
  • INC:环比上升
  • DEC:环比下降
  • HOH_INC:与上小时同比上升
  • HOH_DEC:与上小时同比下降
  • DOD_INC:与昨天同比上升
  • DOD_DEC:与昨天同比下降
DimString域名拆分维度。仅当告警配置了维度拆分时有值。
ThresholdFloat50指标比较阈值
AggrIntervalInteger5聚合周期,单位为分钟。被监控指标在该指定周期内满足指标比较阈值触发告警。
RepeatCntInteger1持续周期,表示聚合周期内的异常指标持续出现指定次数触发告警。
ValsArray of Vals告警指标值列表。维度拆分条件下可能存在多个元素。

Vals

参数类型示例值描述
DimValString图片类型触发告警的拆分维度值,仅当告警配置了维度拆分时有值。
ValFloatpng指标值
ValBaseFloat20指标上一周期值,仅在 Op 为同比/环比相关方法时有值。
ValTimeString2019-06-02T00:00:00+08:00指标值对应的时间。日期格式按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=GetImageAlertRecords&Version=2018-08-01
{
    "StartTime": "2019-06-02T00:00:00+08:00",
    "EndTime": "2019-06-02T01:00:00+08:00"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023061615574388A72E74B3D53A0B790E",
        "Action": "GetImageAlertRecords",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
    	"Total": 1,
    	"HasMore": false,
    	"AlertRecords": [
		    	{
			    		"RuleId": "R1ae373c0-0686-48b5-bf6f-84d529c55881",
              "Name": "test",
              "Phase": "cdn",
              "OS": "iOS",
              "Level": "warn",
              "AlertAt": "2019-06-02T00:05:00+08:00",
              "Marker": "1",
              "AlertCond": {
                  "LogicOp": "or",
                  "AlertContent": [
	                  	{
                            "Item": "cdn_srate",
                            "Func": "avg",
                            "Op": "LE",
                            "Dim": "域名",
                            "Threshold": 1,
                            "AggrInterval": 5,
                            "RepeatCnt": 1
                            "Vals": {
	                            	"DimVal": "图片类型",
		                            "ValTime": "2019-06-02T00:01:00+08:00",
		                            "Val": 1,
		                            "ValBase": 1,
                            }
                        }
                  ]
              },             
    		  }
    	]    	    
    }
}

错误码

访问公共错误码以及通用错误码获取详细信息。