数据开发治理平台 WeData 获取告警规则列表

1. 接口描述

接口请求域名： wedata.tencentcloudapi.com 。

查询告警规则列表

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ListOpsAlarmRules。
Version	是	String	公共参数，本接口取值：2025-08-06。
Region	是	String	公共参数，详见产品支持的地域列表。
ProjectId	是	String	项目id 示例值：147*64
PageNumber	否	Integer	分页的页数，默认为1 示例值：1
PageSize	否	Integer	每页显示的条数，默认为20，最小值为1、最大值为200 示例值：30
MonitorObjectType	否	Integer	监控对象类型, 任务维度监控：可按照任务/工作流/项目来配置：1.任务、2.工作流、3.项目（默认为1.任务）项目维度监控：项目整体任务波动告警， 7：项目波动监控告警示例值：1
TaskId	否	String	根据任务id查询告警规则示例值：202****4486
AlarmType	否	String	查询配置对应告警类型的告警规则告警规则监控类型 failure：失败告警；overtime：超时告警 success：成功告警; backTrackingOrRerunSuccess: 补录重跑成功告警 backTrackingOrRerunFailure：补录重跑失败告警；项目波动告警 projectFailureInstanceUpwardFluctuationAlarm：当天失败实例数向上波动率超过阀值告警； projectSuccessInstanceDownwardFluctuationAlarm：当天成功实例数向下波动率超过阀值告警；离线集成任务对账告警： reconciliationFailure：离线对账任务失败告警 reconciliationOvertime：离线对账任务运行超时告警 reconciliationMismatch：数据对账任务不一致条数超过阀值告警示例值：overtime
AlarmLevel	否	Integer	查询配置了对应告警级别的告警规则告警级别 1.普通、2.重要、3.紧急示例值：1
AlarmRecipientId	否	String	查询配置对应告警接收人的告警规则示例值：2
Keyword	否	String	根据告警规则id/规则名称查询对应的告警规则示例值：ruleName
CreateUserUin	否	String	告警规则创建人过滤示例值：100022256608
CreateTimeFrom	否	String	告警规则创建时间范围起始时间, 格式如2025-08-17 00:00:00 示例值：2025-08-17 00:00:00
CreateTimeTo	否	String	告警规则创建时间范围结束时间，格式如"2025-08-26 23:59:59" 示例值：2025-08-26 23:59:59
UpdateTimeFrom	否	String	最后更新时间过滤告警规则，格式如"2025-08-26 00:00:00" 示例值：2025-08-26 00:00:00
UpdateTimeTo	否	String	最后更新时间过滤告警规则格式如： "2025-08-26 23:59:59" 示例值：2025-08-26 23:59:59

3. 输出参数

参数名称	类型	描述
Data	ListAlarmRulesResult	告警信息信息响应
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 ListOpsAlarmRule

test1

输入示例

POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListOpsAlarmRules
<公共请求参数>

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

输出示例

{
    "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. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation	操作失败。

获取告警规则列表

本页目录：