tencent cloud

ListAlarmMessages
Last updated:2025-11-13 20:54:32
ListAlarmMessages
Last updated: 2025-11-13 20:54:32

1. API Description

Domain name for API request: wedata.intl.tencentcloudapi.com.

This API is used to search the alarm information list.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: ListAlarmMessages.
Version Yes String Common Params. The value used for this API: 2025-08-06.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ProjectId Yes String Project id.
PageNumber No Integer Page number for pagination, minimum value is 1.
PageSize No Integer Specifies the number of items displayed per page. maximum value: 100.
StartTime No String Starting Alarm time. format: yyyy-MM-dd HH:MM:ss.
EndTime No String Specifies the Alarm end time in the format yyyy-MM-dd HH:MM:ss.
AlarmLevel No Integer Alarm level.
AlarmRecipientId No String Alert recipient Id.
TimeZone No String For incoming and returned filter time zone, default UTC+8.

3. Output Parameters

Parameter Name Type Description
Data ListAlarmMessages Alarm information list.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 ListAlarmMessages

This example shows you how to search the alarm information list.

Input Example

POST / HTTP/1.1
Host: wedata.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListAlarmMessages
<Common request parameters>

{
    "ProjectId": "1460947878944567296",
    "PageNumber": 1,
    "PageSize": 20,
    "StartTime": "2025-09-08 16:00:00",
    "EndTime": "2025-09-08 17:00:00",
    "AlarmLevel": 1,
    "AlarmRecipientId": "100042232112"
}

Output Example

{
    "Response": {
        "Data": {
            "PageNumber": 1,
            "PageSize": 20,
            "TotalCount": 100,
            "TotalPageNumber": 5,
            "Items": [
                {
                    "AlarmLevel": 3,
                    "AlarmMessageId": 20,
                    "AlarmReason": "4",
                    "AlarmRecipients": [
                        "mytestdd"
                    ],
                    "AlarmRuleId": "8f258dac-19e4-45c2-ac85-1e69c8626b89",
                    "AlarmTime": "2025-08-09 15:00:00",
                    "AlarmWays": [
                        "email",
                        "sms"
                    ],
                    "CurRunDate": "2022-08-16 00:05:00",
                    "TaskId": "20220822133437682",
                    "TaskName": "alarm_cycleNotCompleted_test"
                }
            ]
        },
        "RequestId": "2022a62a-f8ca-4cc8-8c74-b56191d2d766"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation failed.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback