查询告警记录列表

project_id

是

String

参数解释:

租户ID。用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取方式请参见“获取项目ID”。

约束限制:

不涉及。

取值范围:

字符串的长度必须在 1 到 64个字符之间。

默认取值:

不涉及。

最小长度：1

最大长度：64

alarm_id

否

Array of strings

参数解释：

告警ID列表。告警ID：以al开头，后跟22位由字母或数字组成的字符串。

约束限制：

列表最大长度为50。

最小长度：24

最大长度：24

数组长度：0 - 50

record_id

否

String

参数解释：

告警记录ID。

约束限制：

不涉及。

取值范围：

以ah开头，后跟22位由字母或数字组成的字符串，字符串长度为24。

默认取值：

不涉及。

最小长度：24

最大长度：24

正则匹配：^ah([0-9A-Za-z]){22}$

name

否

String

参数解释：

告警规则名称。

约束限制：

不涉及。

取值范围：

最大128字符长度。

默认取值：

不涉及。

最小长度：0

最大长度：128

status

否

Array of strings

参数解释：

告警规则状态列表。告警规则状态：枚举值，ok为正常，alarm为告警，invalid为已失效。

约束限制：

列表长度最大为3。

数组长度：0 - 3

枚举值：

• ok

• alarm

• invalid

level

否

Integer

参数解释：

告警级别。

约束限制：

不涉及。

取值范围：

枚举值，1为紧急，2为重要，3为次要，4为提示。

默认取值：

不涉及。

最小值：1

最大值：4

namespace

否

String

参数解释：

查询服务的命名空间，各服务命名空间请参考“服务命名空间”。

约束限制：

不涉及。

取值范围：

格式为service.item；service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_。字符串的长度必须在 3 到 32个字符之间。

默认取值：

不涉及。

最小长度：3

最大长度：32

正则匹配：^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*.([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*$

resource_id

否

String

参数解释：

告警资源ID。

约束限制：

不涉及。

取值范围：

多维度情况按字母升序排列并使用逗号分隔。最大字符长度为2048。

默认取值：

不涉及。

最小长度：0

最大长度：2048

正则匹配：^([a-z]|[A-Z]|[0-9]|_|-|:|,|\*|\.|/|#|\(|\))+$

from

否

String

参数解释：

查询告警记录的起始更新时间，例如：2022-02-10T10:05:46+08:00。

约束限制：

不涉及。

取值范围：

最大字符长度为64。

默认取值：

不涉及。

最小长度：0

最大长度：64

to

否

String

参数解释：

查询告警记录的截止更新时间，例如：2022-02-10T10:05:47+08:00。

约束限制：

不涉及。

取值范围：

最大字符长度为64。

默认取值：

不涉及。

最小长度：0

最大长度：64

alarm_type

否

String

参数解释：

告警类型。

约束限制：

不涉及。

取值范围：

枚举值。event:查询事件类型告警，metric:查询指标类型告警。

默认取值：

不涉及。

枚举值：

• event

• metric

create_time_from

否

String

参数解释：

查询告警记录的起始创建时间，例如：2022-02-10T10:05:46+08:00。

约束限制：

不涉及。

取值范围：

最大字符长度为64。

默认取值：

不涉及。

最小长度：0

最大长度：64

create_time_to

否

String

参数解释：

查询告警记录的截止创建时间，例如：2022-02-10T10:05:47+08:00。

约束限制：

不涉及。

取值范围：

最大字符长度为64。

默认取值：

不涉及。

最小长度：0

最大长度：64

offset

否

Integer

参数解释：

分页偏移量。

约束限制：

不涉及。

取值范围：

整数，最小值为0，最大值为1000000000。

默认取值：

0

最小值：0

最大值：1000000000

缺省值：0

limit

否

Integer

参数解释：

分页偏移量。

约束限制：

不涉及。

取值范围：

整数，最小值为1，最大值为100。

默认取值：

100

最小值：1

最大值：100

缺省值：100

正则匹配：^([1-9]|[1-9][0-9]|100)$

order_by

否

String

参数解释：

按关键字排序。

约束限制：

不涉及。

取值范围：

枚举值。first_alarm_time:告警产生时间, update_time:更新时间, alarm_level:告警级别，record_id表记录主键。

默认取值：

update_time

枚举值：

• first_alarm_time

• update_time

• alarm_level

• record_id

Content-Type

否

String

参数解释:

发送的实体的MIME类型。

约束限制:

不涉及。

取值范围:

最小字符数量为1，最大为64。

默认取值:

默认使用application/json; charset=UTF-8。

缺省值：application/json; charset=UTF-8

最小长度：1

最大长度：64

X-Auth-Token

否

String

参数解释:

用户Token。

约束限制:

不涉及。

取值范围:

最小字符数量为1，最大为16384。

默认取值:

不涉及。

最小长度：1

最大长度：16384

alarm_histories

Array of AlarmHistoryItemV2 objects

参数解释：

alarmHistories列表。

数组长度：0 - 100

count

Integer

参数解释：

告警记录列表总数。

取值范围：

不涉及。

最小值：0

最大值：2147483647

record_id

String

参数解释：

告警记录ID。

取值范围：

字符串长度为24。

最小长度：24

最大长度：24

alarm_id

String

参数解释：

告警规则的ID，如：al1603131199286dzxpqK3Ez。

取值范围：

字符串长度为24

最小长度：24

最大长度：24

name

String

参数解释：

告警规则的名称，如：alarm-test01。

取值范围：

字符串长度在 1 到 128 之间。

最小长度：1

最大长度：128

status

String

参数解释：

告警记录的状态。

取值范围：

取值为ok，alarm，invalid, ok_manual；

ok为正常，alarm为告警，invalid为已失效,ok_manual为手动恢复。

枚举值：

• ok

• alarm

• invalid

• ok_manual

level

Integer

参数解释：

告警记录的告警级别。

取值范围：

值为1,2,3,4；1为紧急，2为重要，3为次要，4为提示。

枚举值：

• 1

• 2

• 3

• 4

type

String

参数解释：

告警规则类型。

取值范围：

枚举值。ALL_INSTANCE为全部资源指标告警，RESOURCE_GROUP为资源分组指标告警，MULTI_INSTANCE为指定资源指标告警，EVENT.SYS为系统事件告警，EVENT.CUSTOM自定义事件告警，DNSHealthCheck为健康检查告警。

枚举值：

• EVENT.SYS

• EVENT.CUSTOM

• DNSHealthCheck

• RESOURCE_GROUP

• MULTI_INSTANCE

• ALL_INSTANCE

正则匹配：^(EVENT.SYS|EVENT.CUSTOM|DNSHealthCheck|RESOURCE_GROUP|MULTI_INSTANCE|ALL_INSTANCE)$

action_enabled

Boolean

参数解释：

是否发送通知

取值范围：

true：发送通知

false：不发送通知

begin_time

String

参数解释：

产生时间,UTC时间

取值范围：

不涉及。

end_time

String

参数解释：

结束时间，UTC时间

取值范围：

不涉及。

first_alarm_time

String

参数解释：

第一次告警时间，UTC时间

取值范围：

不涉及。

last_alarm_time

String

参数解释：

最后一次告警时间，UTC时间。

取值范围：

不涉及。

alarm_recovery_time

String

参数解释：

告警恢复时间，UTC时间。

取值范围：

不涉及。

metric

metric object

参数解释:

指标信息。

condition

condition object

参数解释：

告警触发条件。

additional_info

AdditionalInfo object

参数解释：

告警记录额外字段，仅针对事件监控告警场景所产生的告警记录信息。

alarm_actions

Array of alarm_actions objects

参数解释：

告警触发的动作列表。 结构如下： { "type": "notification", "notification_list":

["urn:smn:southchina:68438a86d98e427e907e0097b7e35d47:sd"] } type取值：

notification：通知。 autoscaling：弹性伸缩。

notification_list：告警状态发生变化时，被通知对象的列表。

数组长度：0 - 10

ok_actions

Array of ok_actions objects

参数解释：

告警恢复触发的动作。 结构如下： { "type": "notification", "notification_list":

["urn:smn:southchina:68438a86d98e427e907e0097b7e35d47:sd"] }

type取值： notification：通知。 notification_list：告警状态发生变化时，被通知对象的列表。

数组长度：0 - 10

data_points

Array of DataPointInfo objects

计算出该条告警记录的资源监控数据上报时间和监控数值。

数组长度：0 - 2147483647

namespace

String

参数解释：

查询服务的命名空间，各服务命名空间请参考“服务命名空间”。

取值范围：

字符串长度在 3 到 32 之间。

最小长度：3

最大长度：32

metric_name

String

参数解释：

资源的监控指标名称。如：弹性云服务器中的监控指标cpu_util，表示弹性服务器的CPU使用率；文档数据库中的指标mongo001_command_ps，表示command执行频率；各服务的指标名称可查看：“服务指标名称”。

取值范围：

字符串长度在 1 到 64 之间。

最小长度：1

最大长度：64

dimensions

Array of dimensions objects

参数解释：

指标维度。

取值范围：

不涉及。

数组长度：0 - 4

name

String

参数解释：

资源维度，如：弹性云服务器，则维度为instance_id；目前最大支持4个维度，各服务资源的指标维度名称可查看：“服务维度名称”。

取值范围：

字符串长度在 1 到 32 之间。

最小长度：1

最大长度：32

正则匹配：^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-)*$

value

String

参数解释：

资源维度值，为资源的实例ID，如：4270ff17-aba3-4138-89fa-820594c39755。

取值范围：

字符串长度在 1 到 256 之间。

最小长度：1

最大长度：256

正则匹配：^((([a-z]|[A-Z]|[0-9]|\*|_|/|#|\(|\)){1}([a-z]|[A-Z]|[0-9]|_|-|\.|\*|/|#|\(|\))*))$

period

Integer

参数解释：

指标周期，单位是秒。如想了解各个云服务的指标原始周期可以参考“支持服务列表”。

取值范围：

0是默认值，例如事件类告警该字段就用0即可；

1代表指标的原始周期，比如RDS监控指标原始周期是60s，表示该RDS指标按60s周期为一个数据点参与告警计算；

300代表指标按5分钟聚合周期为一个数据点参与告警计算；

1200代表指标按20分钟聚合周期为一个数据点参与告警计算；

3600代表指标按60分钟聚合周期为一个数据点参与告警计算；

14400代表指标按4小时聚合周期为一个数据点参与告警计算；

86400代表指标按1天聚合周期为一个数据点参与告警计算。

枚举值：

• 0

• 1

• 300

• 1200

• 3600

• 14400

• 86400

filter

String

参数解释：

聚合方式。

取值范围：

枚举值。average：平均值，variance：方差，min：最小值，max：最大值，sum：求和。字符长度在 1 到 15之间。

最小长度：1

最大长度：15

正则匹配：^(average|variance|min|max|sum)$

comparison_operator

String

参数解释：

阈值符号。

取值范围：

枚举值。支持的值为(>|<|>=|<=|=|!=|cycle_decrease|cycle_increase|cycle_wave);cycle_decrease为环比下降,cycle_increase为环比上升,cycle_wave为环比波动。字符长度在 1 到 10之间。

最小长度：1

最大长度：10

正则匹配：^(>|<|>=|<=|=|!=|cycle_decrease|cycle_increase|cycle_wave)$

value

Double

参数解释：

告警阈值。

取值范围：

具体阈值取值请参见附录中各服务监控指标中取值范围，如支持监控的服务列表中ECS的CPU使用率cpu_util取值范围可配置80。最小值为0，最大值为1.7976931348623157e+108。

最小值：0

最大值：1.7976931348623156E108

unit

String

参数解释：

数据的单位。

取值范围：

字符串长度最大为 32。

最小长度：0

最大长度：32

count

Integer

参数解释：

告警连续触发次数。

取值范围：

字符串长度在 1 到 180 之间。

最小值：1

最大值：180

suppress_duration

Integer

参数解释：

告警抑制时间（告警周期），单位为秒，对应页面上创建告警规则时告警策略最后一个字段，该字段主要为解决告警频繁的问题。

取值范围：

枚举值，只能为0、300、600、900、1800、3600、10800、21600、43200、86400。

• 0：在立即触发场景中，0代表不抑制；在累计触发场景，0代表只告警一次。

• 300代表满足告警触发条件后每5分钟告警一次。

• 600代表满足告警触发条件后每10分钟告警一次。

• 900代表满足告警触发条件后每15分钟告警一次。

• 1800代表满足告警触发条件后每30分钟告警一次。

• 3600代表满足告警触发条件后每60分钟告警一次。

• 10800代表满足告警触发条件后每3小时告警一次。

• 21600代表满足告警触发条件后每6小时告警一次。

• 43200代表满足告警触发条件后每12小时告警一次。

• 86000代表满足告警触发条件后每一天告警一次。

枚举值：

• 0

• 300

• 600

• 900

• 1800

• 3600

• 10800

• 21600

• 43200

• 86400

正则匹配：^(0|300|600|900|1800|3600|10800|21600|43200|86400)$

resource_id

String

参数解释：

该条告警记录对应的资源ID；如：22d98f6c-16d2-4c2d-b424-50e79d82838f。

取值范围：

字符串长度最大为128。

最小长度：0

最大长度：128

resource_name

String

参数解释：

该条告警记录对应的资源名称；如：ECS-Test01。

取值范围：

字符串长度最大为128。

最小长度：0

最大长度：128

event_id

String

参数解释：

该条告警记录对应的事件监控ID，资源所产生的事件；如：ev16031292300990kKN8p17J。

取值范围：

字符串长度为24。

最小长度：24

最大长度：24

type

String

参数解释：

通知类型。

取值范围：

枚举值。notification为SMN通知，contact为云账号联系人，contactGroup为通知组。autoscaling为AS通知，只在AS中使用，不推荐客户使用。groupwatch、ecsRecovery及iecAction，已废弃，不推荐使用。

枚举值：

• notification

• autoscaling

• groupwatch

• ecsRecovery

• contact

• contactGroup

• iecAction

notification_list

Array of strings

参数解释：

告警状态发生变化时，被通知对象的列表。topicUrn可从SMN获取，具体操作请参考查询Topic列表。

数组长度：0 - 20

type

String

参数解释：

通知类型。

取值范围：

枚举值。notification为SMN通知，contact为云账号联系人，contactGroup为通知组。autoscaling为AS通知，只在AS中使用，不推荐客户使用。groupwatch、ecsRecovery及iecAction，已废弃，不推荐使用。

枚举值：

• notification

• autoscaling

• groupwatch

• ecsRecovery

• contact

• contactGroup

• iecAction

notification_list

Array of strings

参数解释：

告警状态发生变化时，被通知对象的列表。topicUrn可从SMN获取，具体操作请参考查询Topic列表。

数组长度：0 - 20

time

String

参数解释：

计算出该条告警记录的资源监控数据上报的UTC时间。

取值范围：

字符串长度在 1 到 64 之间。

最小长度：1

最大长度：64

value

Double

参数解释：

计算出该条告警记录的资源监控数据在该时间点的监控数值，如：7.019。

取值范围：

整数，最小值为0，最大值为1.7976931348623157e+308。

最小值：0

最大值：1.7976931348623157E308

error_code

String

请求异常内部业务状态码

最小长度：0

最大长度：256

error_msg

String

请求异常信息

最小长度：0

最大长度：256

request_id

String

请求ID

最小长度：0

最大长度：256

error_code

String

请求异常内部业务状态码

最小长度：0

最大长度：256

error_msg

String

请求异常信息

最小长度：0

最大长度：256

request_id

String

请求ID

最小长度：0

最大长度：256

200

查询成功

400

参数校验失败

500

系统内部错误