获取告警规则详细信息

最近更新时间:2025-09-23 00:18:34

我的收藏

1. 接口描述

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

根据告警规则id/名称查询单个告警规则信息

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:GetOpsAlarmRule。
Version String 公共参数,本接口取值:2025-08-06。
Region String 公共参数,详见产品支持的 地域列表
ProjectId String 项目id
示例值:146****537296
AlarmRuleId String 告警规则唯一id
示例值:ac11ae*0cd9db4

3. 输出参数

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

4. 示例

示例1 GetOpsAlarmRuleDetail

输入示例

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

{
    "ProjectId": "1460947878944567296",
    "AlarmRuleId": "d736b8ba-b6d9-4a21-824a-84bdda3d9731"
}

输出示例

{
    "Response": {
        "Data": {
            "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": "d736b8ba-b6d9-4a21-824a-84bdda3d9731",
            "AlarmRuleName": "ruleName222",
            "AlarmTypes": [
                "failure"
            ],
            "BundleId": "",
            "BundleInfo": "",
            "Description": "",
            "MonitorObjectIds": [
                "832b83ea-d285-43bd-b4bb-5a268aa8cb50"
            ],
            "MonitorObjectType": 2,
            "Status": 1
        },
        "RequestId": "2bd5ce52-4cc5-4338-aa40-b203ef6160ff"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
ResourceNotFound 资源不存在。