Docs

Cloud Monitor

Alert history

ListSendAlert

Query the list of alert notifications sent.

Request descriptions

Request method: POST

Request URL: https://cloudmonitor.cn-beijing.volcengineapi.com?Action=ListSendAlert&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.

Go to debug

Request descriptions

Parameters	Type	Required	Sample value	Description
Action	String	Yes	ListSendAlert	The name of the API. The API name is ListSendAlert.
Version	String	Yes	2018-01-01	The API version. The current API version is 2018-01-01.
AlertGroupId	String	No	633508858e241506ac******	ID of the alert history list. You can call the ListAlertGroup API to obtain the alert history list ID.
PageNumber	Integer	No	1	Page number of the list. The value must be greater than 0. The default value is 1. The list range to be queried is: Actual start index = (PageNumber-1) * PageSize Actual end index = PageNumber * PageSize
PageSize	Integer	No	10	Number of rows per page for a pagination query. The default value is 10.

Sample request

POST https://cloudmonitor.cn-beijing.volcengineapi.com?Action=ListSendAlert&Version=2018-01-01​
Content-Type: application/json​
{​
    "AlertGroupId": "633508858e241506ac******",​
    "PageNumber": 1,​
    "PageSize": 10​
}​

Response parameters

Parameters	Type	Sample value	Description
Data	Array of SendAlertVO	-	Returned data.
TotalCount	Integer	2	Total number of alert records within the time period.

SendAlertVO

Parameters	Types	Sample value	Description
Id	String	63340e8f4f5b3bdee9b*****	ID of the historical alert.
SendAt	String	2022-09-28T09:06:23.65Z	Time when the alert was sent.
SendResult	Array of SendResult	-	The content of the historical alert.

SendResult

Parameters	Type	Sample value	Description
ErrMsg	String	-	Error message. If it is empty, no error exists.
Success	Boolean	true	Result of alert message sending. true: Success false: Failure
Receiver	String	63329d689e5b169425******	ID of the alert sending record. For example, if the alert method is email, this parameter is the email address of the alert recipient.
AlertMethod	String	API	The alert notification method. Email: Email Phone: Phone SMS: SMS API: Alert callback

Sample response

{​
    "ResponseMetadata": {​
        "Action": "ListSendAlert",​
        "Region": "cn-beijing",​
        "Service": "cloudmonitor",​
        "Version": "2018-01-01",​
        "RequestId": "20230604110420****100232280022D31"​
    },​
    "Result": {​
        "Data": [​
            {​
                "Id": "63340e8f4f5b3bdee9b*****",​
                "SendAt": "2022-09-28T09:06:23.65Z",​
                "SendResult": [​
                    {​
                        "ErrMsg": "",​
                        "Success": true,​
                        "Receiver": "63329d689e5b169425******",​
                        "AlertMethod": "API"​
                    },​
                    {​
                        "ErrMsg": "",​
                        "Success": true,​
                        "Receiver": "abc@example.com",​
                        "AlertMethod": "Email"​
                    },​
                    {​
                        "ErrMsg": "",​
                        "Success": true,​
                        "Receiver": "1503875****",​
                        "AlertMethod": "SMS"​
                    }​
                ]​
            }​
        ],​
        "PageSize": 30,​
        "PageNumber": 1,​
        "TotalCount": 2​
    }​
}​

Error code

There are no error codes specific to this API. For more information, see Error codes.

Last updated: 2026.07.10 14:02:24