报警规则查询-腾讯云可观测平台-文档中心-腾讯云

1. 接口描述

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

Prometheus 报警规则查询接口

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeAlertRules。
Version	是	String	公共参数，本接口取值：2018-07-24。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	Prometheus 实例 ID 示例值：my-prom-gg
Limit	否	Integer	返回数量，默认为 20，最大值为 100 示例值：10
Offset	否	Integer	偏移量，默认为 0 示例值：0
RuleId	否	String	规则 ID 示例值：arule-f2vx278
RuleState	否	Integer	规则状态码，取值如下： 2=RuleEnabled 3=RuleDisabled 示例值：2
RuleName	否	String	规则名称示例值：告警规则测试
Type	否	String	报警策略模板分类示例值：TargetDown

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	报警规则数量示例值：2
AlertRuleSet	Array of PrometheusRuleSet	报警规则详情注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询报警规则

输入示例

https://monitor.tencentcloudapi.com/?Action=DescribeAlertRules
&InstanceId=my-prom-gg
&RuleState=2
&Limit=10
&<公共请求参数>

输出示例

{
    "Response": {
        "AlertRuleSet": [
            {
                "RuleId": "arule-c9qvmfm8",
                "RuleName": "example6",
                "RuleState": 3,
                "Type": "",
                "Labels": [
                    {
                        "Key": "k1",
                        "Value": "v1"
                    },
                    {
                        "Key": "k2",
                        "Value": "v2"
                    }
                ],
                "Expr": "up{service=\"rig-prometheus-agent\"} > 0",
                "Annotations": [
                    {
                        "Key": "ak1",
                        "Value": "av1"
                    },
                    {
                        "Key": "ak2",
                        "Value": "av2"
                    }
                ],
                "Duration": "1m",
                "Receivers": [
                    "123",
                    "456"
                ],
                "CreatedAt": "2020-08-24T09:39:27Z",
                "UpdatedAt": "2020-08-24T09:39:27Z"
            },
            {
                "RuleId": "arule-nnqzmis6",
                "RuleName": "example5",
                "RuleState": 2,
                "Type": "",
                "Labels": [
                    {
                        "Key": "k1",
                        "Value": "v1"
                    },
                    {
                        "Key": "k2",
                        "Value": "v2"
                    }
                ],
                "Expr": "up{service=\"rig-prometheus-agent\"} > 0",
                "Annotations": [
                    {
                        "Key": "ak1",
                        "Value": "av1"
                    },
                    {
                        "Key": "ak2",
                        "Value": "av2"
                    }
                ],
                "Duration": "1m",
                "Receivers": [
                    "123",
                    "456"
                ],
                "CreatedAt": "2020-08-24T09:39:17Z",
                "UpdatedAt": "2020-08-24T09:39:17Z"
            }
        ],
        "RequestId": "-fp6ttca3mlpv34ks85fv3661vja2bwg",
        "TotalCount": 2
    }
}

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: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
FailedOperation	操作失败。
FailedOperation.BadYamlFormat	Yaml 格式不正确。
FailedOperation.DbQueryFailed	数据库查询失败。
FailedOperation.DbRecordCreateFailed	创建数据库记录失败。
FailedOperation.DbRecordDeleteFailed	数据库记录删除失败。
FailedOperation.DbRecordUpdateFailed	数据库记录更新失败。
FailedOperation.GenerateInstanceIDFailed	生成资源ID错误。
FailedOperation.ResourceExist	资源已经存在。
FailedOperation.ResourceNotFound	资源不存在。
InternalError	内部错误。
InvalidParameter	参数错误。

报警规则查询

本页目录：