Cloud Monitor
Cloud Monitor
Document
- Documentation
Cloud MonitorAPI referenceAlert historyListAlert
Copy page
Download PDFAlert history
ListAlert
Copy pageDownload PDFListAlert
Obtain the details of alert records.
Request descriptions
Cloud Monitor is deployed across multiple regions worldwide to provide more stable and low-latency access. You can refer to the Service addresses topic to choose an access point that is optimal for your service region.
- Request method: POST
- Request URL: https://cloudmonitor.cn-beijing.volcengineapi.com?Action=ListAlert&Version=2018-01-01
Debugging
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
Request descriptions
Sample request
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
}
Response parameters
Parameters | Type | Sample value | Description |
Data | - | The historical alert data. | |
PageSize | Integer | 30 | The number of rows per page for a pagination query. Default value: 30. |
PageNumber | Integer | 1 | The page number for a pagination query. Default value: 1. |
TotalCount | Integer | 2 | The number of alert policies that meet the criteria. |
AlertVO
Parameters | Type | Sample value | Description |
Id | String | alert_20***********23**** | The alert ID for the current cycle. |
Type | String | alert | The alert type. Valid values:
|
EndAt | String | 2026-06-08T12:05:00 | The end time of the alert for the current cycle. |
Level | String | warning | The alert level. Valid values:
|
CreateAt | String | 2026-06-08T12:00:00 | The start time of the alert for the current cycle. |
EvaluationCount | Integer | 3 | The number of consecutive times the alert condition must be triggered. It is used to trigger N alerts within M cycles. EvaluationInterval indicates M, and EvaluationCount indicates N. |
SendAlertResult | - | The alert sending results. | |
MetricConditions | - | The alert metric conditions. | |
EvaluationInterval | Integer | 5 | The check cycle is used to trigger N alerts within M cycles. EvaluationInterval indicates M, and EvaluationCount indicates N. |
SendAlertResult
Parameters | Type | Sample value | Description |
Status | String | sent | The alert sending status. Valid values:
|
IsSendAlert | Boolean | true | Whether the alert was sent.
|
SilencePolicyId | String | sp_20***********23**** | The ID of the alert suppression policy. If this ID exists, it indicates that the alert is suppressed. |
SendAlertNotifications | - | The information about alert notifications. |
MetricCondition
Parameters | Types | Sample value | Description |
Metric | String | AVG(Instance/CPU utilization)[1m] | The semantic description of the metric. |
Condition | String | alert | The metric status. Valid values:
|
CurrentValue | String | 86.4 | The current value of the metric. |
TriggerCondition | String | The average value of instance/CPU utilization in the last cycle is >= 90%, and the condition is met per cycle (1 cycle = 1 minute) | The semantic description of the metric trigger condition. |
SendAlertNotification
Parameters | Type | Sample value | Description |
Type | String | alert | The alert type. Valid values:
|
Level | String | warning | The alert level. Valid values:
|
ErrMsg | String | {"body":"ok","code":200} | The description of the alert sending status. |
SendAt | String | 2026-06-08T12:01:00 | The time when the alert was sent. |
Status | String | sent | The alert sending status. Valid values:
|
SendAlertOOSs | - | The information about alert sending orchestration. | |
SilencePolicyId | String | sp_20***********23**** | The ID of the alert suppression policy. If this ID exists, it indicates that the alert is suppressed. |
SendAlertContacts | - | The information about alert contacts. | |
SendAlertWebhooks | - | The information about webhooks used for sending alerts. |
SendAlertOOS
Parameters | Type | Sample value | Description |
ErrMsg | String | {"body":"ok","code":200} | The description of the alert sending status. |
Region | String | cn-north-1 | The region. |
Status | String | sent | The alert sending status. Valid values:
|
Success | Boolean | true | Whether the alert was sent. |
OrchestrationPlanId | String | oop-20***********23**** | The orchestration plan ID. |
SendAlertContact
Parameters | Types | Sample value | Description |
ContactName | String | user_20***********23**** | The name of the alert contact. |
DutyScheduleId | String | ds_20***********23**** | The on-duty schedule ID. |
ContactSendResults | - | The information about alert contacts. |
SendAlertWebhook
SendAlertContactResult
Parameters | Type | Sample value | Description |
ErrMsg | String | {"body":"ok","code":200} | The description of the alert sending status. |
Status | String | sent | The alert sending status. Valid values:
|
Success | Boolean | true | Whether the alert was sent. |
AlertMethod | String | Email | The channel through which the alert is sent to the contact. Valid values: Phone, Email, and SMS. |
AlertMethodVal | String | u***@example.com | The contact information, such as email addresses and mobile numbers. |
Sample response
{
"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"
}
}
Error code
Last updated: 2026.06.22 19:14:36
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
