tencent cloud

ListOpsAlarmRules
Last updated:2025-11-13 20:54:31
ListOpsAlarmRules
Last updated: 2025-11-13 20:54:31

1. API Description

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

This API is used to query the alarm rule 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: ListOpsAlarmRules.
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. defaults to 1.
PageSize No Integer Number of items to display per page, defaults to 20, minimum value 1, maximum value 200.
MonitorObjectType No Integer Monitoring Object Type

Task-level Monitoring - Can be configured by Task / Workflow / Project:
1 = Task (default)
2 = Workflow
3 = Project

Project-level Monitoring - Monitors overall task fluctuations within a project:
7 = Project fluctuation monitoring alarm
TaskId No String Based on task id, queries Alarm rules.
AlarmType No String Alarm Rule Monitoring Types:

failure: Failure alarm

overtime: Timeout alarm

success: Success alarm

backTrackingOrRerunSuccess: Alarm when backfill/rerun succeeds

backTrackingOrRerunFailure: Alarm when backfill/rerun fails

projectFailureInstanceUpwardFluctuationAlarm: Alarm when the upward fluctuation rate of failed instances for the day exceeds the threshold

projectSuccessInstanceDownwardFluctuationAlarm: Alarm when the downward fluctuation rate of successful instances for the day exceeds the threshold

reconciliationFailure: Alarm when an offline reconciliation task fails

reconciliationOvertime: Alarm when an offline reconciliation task runs overtime

reconciliationMismatch: Alarm when the number of mismatched records in reconciliation exceeds the threshold
AlarmLevel No Integer Queries Alarm rules configured with corresponding Alarm levels.
Valid values: 1. ordinary, 2. important, 3. critical.
AlarmRecipientId No String Query the alarm rules associated with the configured alarm recipients.
Keyword No String Queries the corresponding Alarm rule based on Alarm rule id or rule name.
CreateUserUin No String Specifies the creator filter for Alarm rule creation.
CreateTimeFrom No String Start time of the Alarm rule create time range, in the format of 2025-08-17 00:00:00.
CreateTimeTo No String End time of the Alarm rule creation time range, in the format of "2025-08-26 23:59:59".
UpdateTimeFrom No String Filters Alarm rules by last update time, in the format of "2025-08-26 00:00:00".
UpdateTimeTo No String Filters Alarm rules by last update time in the format of "2025-08-26 23:59:59".

3. Output Parameters

Parameter Name Type Description
Data ListAlarmRulesResult Alarm information response.
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 ListOpsAlarmRule

test1

Input Example

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

{
    "ProjectId": "1460947878944567296",
    "PageNumber": 1,
    "PageSize": 10,
    "AlarmType": "overtime"
}

Output Example

{
    "Response": {
        "Data": {
            "Items": [
                {
                    "AlarmGroups": [
                        {
                            "AlarmEscalationInterval": 0,
                            "AlarmEscalationRecipientIds": [],
                            "AlarmRecipientIds": [],
                            "AlarmRecipientType": 2,
                            "AlarmWays": [
                                "1"
                            ],
                            "NotificationFatigue": {
                                "NotifyCount": 1,
                                "NotifyInterval": 5,
                                "QuietIntervals": []
                            },
                            "WebHooks": []
                        }
                    ],
                    "AlarmLevel": 1,
                    "AlarmRuleDetail": {
                        "DataBackfillOrRerunTimeOutExtInfo": null,
                        "DataBackfillOrRerunTrigger": 1,
                        "ProjectInstanceStatisticsAlarmInfoList": null,
                        "ReconciliationExtInfo": null,
                        "TimeOutExtInfo": [
                            {
                                "Hour": null,
                                "Min": 1,
                                "RuleType": 1,
                                "ScheduleTimeZone": null,
                                "Type": 1
                            }
                        ],
                        "Trigger": 2
                    },
                    "AlarmRuleId": "4453641b-3051-4c66-9ff9-a73734c1d1c5",
                    "AlarmRuleName": "ruleName111",
                    "AlarmTypes": [
                        "failure"
                    ],
                    "BundleId": "",
                    "BundleInfo": "",
                    "Description": "",
                    "MonitorObjectIds": [
                        "832b83ea-d285-43bd-b4bb-5a268aa8cb50"
                    ],
                    "MonitorObjectType": 2,
                    "Status": 1
                }
            ],
            "PageNumber": 1,
            "PageSize": 10,
            "TotalCount": 24,
            "TotalPageNumber": 3
        },
        "RequestId": "ebabd563-dd4c-41e9-a184-68d3730d4038"
    }
}

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