You need to enable JavaScript to run this app.
文档中心
云监控

云监控

复制全文
下载 pdf
告警历史
ListAlert
复制全文
下载 pdf
ListAlert
获取告警历史详情。​
请求说明​
云监控已在全球多个地域部署服务,旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅 服务地址 文档,根据业务所在地选择最合适的接入点。​
  • 请求方式:POST​
  • 请求地址:https://cloudmonitor.cn-beijing.volcengineapi.com?Action=ListAlert&Version=2018-01-01​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
​
参数​
类型​
是否必选​
示例值​
描述​
Action​
String​
是​
ListAlert​
接口名称。当前 API 的名称为 ListAlert。​
Version​
String​
是​
2018-01-01​
接口版本。当前 API 的版本为 2018-01-01。​
AlertGroupId​
String​
是​
ag_20***********23****​
告警历史 ID。通过 ListAlertGroup 接口获取。​
EndTime​
Integer​
否​
1749376800​
查询结束时间,秒级时间戳,不配置时默认为当前时间。​
PageNumber​
Integer​
否​
1​
分页页码,默认为 1。​
PageSize​
Integer​
否​
10​
分页每页数量,默认为 10。​
StartTime​
Integer​
否​
1749355200​
查询开始时间,秒级时间戳,不配置时默认为最近 6 小时数据。​
​
请求示例​
​
POST https://cloudmonitor.cn-beijing.volcengineapi.com?Action=ListAlert&Version=2018-01-01​
Content-Type: application/json​
{​
"AlertGroupId": "ag_20***********23****",​
"EndTime": 1749376800,​
"PageNumber": 1,​
"PageSize": 10,​
"StartTime": 1749355200​
}
​
返回参数​
​
参数​
类型​
示例值​
描述​
Data​
Array of AlertVO​
-​
告警历史数据记录。​
PageSize​
Integer​
30​
分页查询参数,用于设置每页行数,默认值为 30。​
PageNumber​
Integer​
1​
分页查询参数,用于设置当前页码,默认值为 1。​
TotalCount​
Integer​
2​
符合条件的告警策略数量。​
​
AlertVO​
​
参数​
类型​
示例值​
描述​
Id​
String​
alert_20***********23****​
本周期告警 ID。​
Type​
String​
alert​
告警类型,枚举值包括:​
  • alert:告警​
  • recovery:恢复​
  • nodata:无数据​
EndAt​
String​
2026-06-08T12:05:00​
本周期告警结束时间。​
Level​
String​
warning​
告警等级,枚举值包括:​
  • critical:严重​
  • warning:警告​
  • notice:通知​
  • recovery:恢复​
CreateAt​
String​
2026-06-08T12:00:00​
本周期告警开始时间。​
EvaluationCount​
Integer​
3​
触发告警需要持续的周期,用于实现 M 个周期 N 次告警。其中,EvaluationInterval 表示 M,EvaluationCount 表示 N。​
SendAlertResult​
Object of SendAlertResult​
-​
告警发送结果。​
MetricConditions​
Array of MetricCondition​
-​
告警指标条件。​
EvaluationInterval​
Integer​
5​
检查周期,用于实现 M 个周期 N 次告警。其中,EvaluationInterval 表示 M,EvaluationCount 表示 N。​
​
SendAlertResult​
​
参数​
类型​
示例值​
描述​
Status​
String​
sent​
告警发送状态,枚举值包括:​
  • sent:已发送​
  • recovery_disabled:恢复被禁用​
  • silenced:已屏蔽​
  • no_receiver:未配置接收人​
  • rule_send_interval:不满足发送间隔未发送。​
IsSendAlert​
Boolean​
true​
是否发送告警。​
  • true:发送告警。​
  • false:不发送告警。​
SilencePolicyId​
String​
sp_20***********23****​
告警屏蔽策略 ID,如果存在此 ID,则表示被屏蔽。​
SendAlertNotifications​
-​
告警通知记录。​
​
MetricCondition​
​
参数​
类型​
示例值​
描述​
Metric​
String​
AVG(实例/CPU利用率)[1m]​
指标的语义化描述。​
Condition​
String​
alert​
指标状态,枚举值包括:​
  • alert:告警​
  • nodata:无数据​
  • normal:正常​
CurrentValue​
String​
86.4​
指标的当前值。​
TriggerCondition​
String​
实例/CPU利用率 统计在最近1个周期内平均值 >= 90%,且1个周期内1次满足条件(1周期=1分钟)​
指标触发条件的语义化描述。​
​
SendAlertNotification​
​
参数​
类型​
示例值​
描述​
Type​
String​
alert​
告警类型,枚举值包括:​
  • alert:告警​
  • nodata:无数据​
  • alert_recovery:告警恢复​
  • nodata_recovery:无数据恢复​
Level​
String​
warning​
告警等级,枚举值包括:​
  • critical:严重​
  • warning:警告​
  • notice:通知​
  • recovery:恢复​
ErrMsg​
String​
{"body":"ok","code":200}​
告警发送状态描述。​
SendAt​
String​
2026-06-08T12:01:00​
告警发送时间。​
Status​
String​
sent​
告警发送状态,枚举值包括:​
  • sent:已发送​
  • recovery_disabled:恢复被禁用​
  • silenced:已屏蔽​
  • no_receiver:未配置接收人​
  • rule_send_interval:不满足发送间隔未发送。​
SendAlertOOSs​
Array of SendAlertOOS​
-​
告警发送 OOS (运维编排) 记录​
SilencePolicyId​
String​
sp_20***********23****​
告警屏蔽策略 ID,若存在此 ID 则表示被屏蔽。​
SendAlertContacts​
Array of SendAlertContact​
-​
告警发送联系人记录。​
SendAlertWebhooks​
Array of SendAlertWebhook​
-​
告警发送 Webhook 记录。​
​
SendAlertOOS​
​
参数​
类型​
示例值​
描述​
ErrMsg​
String​
{"body":"ok","code":200}​
告警发送状态描述。​
Region​
String​
cn-north-1​
地域。​
Status​
String​
sent​
告警发送状态,枚举值包括:​
  • waiting:待发送​
  • sent:已发送​
Success​
Boolean​
true​
是否成功发送。​
OrchestrationPlanId​
String​
oop-20***********23****​
运维编排计划 ID。​
​
SendAlertContact​
​
参数​
类型​
示例值​
描述​
ContactName​
String​
user_20***********23****​
告警发送联系人名称。​
DutyScheduleId​
String​
ds_20***********23****​
值班计划 ID。​
ContactSendResults​
-​
告警发送联系人记录。​
​
SendAlertWebhook​
​
参数​
类型​
示例值​
描述​
Url​
String​
https://example.org/webhook​
Webhook 地址。​
Name​
String​
default_webhook​
Webhook 名称。​
Type​
String​
custom​
Webhook 类型。​
ErrMsg​
String​
{"body":"ok","code":200}​
告警发送状态描述。​
Status​
String​
sent​
告警发送状态,枚举值包括:​
  • waiting:待发送​
  • sent:已发送​
Success​
Boolean​
true​
是否成功发送。​
​
SendAlertContactResult​
​
参数​
类型​
示例值​
描述​
ErrMsg​
String​
{"body":"ok","code":200}​
告警发送状态描述。​
Status​
String​
sent​
告警发送状态,枚举值包括:​
  • waiting:待发送​
  • sent:已发送​
Success​
Boolean​
true​
是否成功发送。​
AlertMethod​
String​
Email​
告警发送联系人渠道,示例值 Phone、Email、SMS。​
AlertMethodVal​
String​
u***@example.com​
联系人值,例如:邮箱地址、电话号码等。​
​
返回示例​
​
{​
"Result": {​
"Data": [​
{​
"Id": "alert_20***********23****",​
"Type": "alert",​
"EndAt": "2026-06-08T12:05:00",​
"Level": "warning",​
"CreateAt": "2026-06-08T12:00:00",​
"EvaluationCount": 3,​
"SendAlertResult": {​
"Status": "sent",​
"IsSendAlert": true,​
"SilencePolicyId": "sp_20***********23****",​
"SendAlertNotifications": [​
{​
"Type": "alert",​
"Level": "warning",​
"ErrMsg": "{"body":"ok","code":200}",​
"SendAt": "2026-06-08T12:01:00",​
"Status": "sent",​
"SendAlertOOSs": [​
{​
"ErrMsg": "{"body":"ok","code":200}",​
"Region": "cn-north-1",​
"Status": "sent",​
"Success": true,​
"OrchestrationPlanId": "oop-20***********23****"​
}​
],​
"SilencePolicyId": "sp_20***********23****",​
"SendAlertContacts": [​
{​
"ContactName": "user_20***********23****",​
"DutyScheduleId": "ds_20***********23****",​
"ContactSendResults": [​
{​
"ErrMsg": "{"body":"ok","code":200}",​
"Status": "sent",​
"Success": true,​
"AlertMethod": "Email",​
"AlertMethodVal": "u***@example.com"​
}​
]​
}​
],​
"SendAlertWebhooks": [​
{​
"Url": "https://example.org/webhook",​
"Name": "default_webhook",​
"Type": "custom",​
"ErrMsg": "{"body":"ok","code":200}",​
"Status": "sent",​
"Success": true​
}​
]​
}​
]​
},​
"MetricConditions": [​
{​
"Metric": "AVG(Instance/CPU Utilization)[1m]",​
"Condition": "alert",​
"CurrentValue": "86.4",​
"TriggerCondition": "Instance/CPU Utilization Average value calculated over the latest single cycle >= 90%,and the threshold conditions is met once within one cycle(1 cycle=1 minute)"​
}​
],​
"EvaluationInterval": 5​
}​
],​
"PageSize": 30,​
"PageNumber": 1,​
"TotalCount": 2​
},​
"ResponseMetadata": {​
"Env": "",​
"Action": "ListAlert",​
"Region": "cn-beijing",​
"Service": "cloudmonitor",​
"Version": "2018-01-01",​
"RequestId": "20230604110420****100232280022D31"​
}​
}
​
错误码​
本接口无特有的错误码。更多信息请参见 错误码。​
最近更新时间:2026.08.11 20:28:02
这个页面对您有帮助吗?
有用
有用
无用
无用