操作指南

API 文档

云产品监控指标

填写文档满意度调查问卷,赢取缤纷好礼> HOT

查询预聚合规则

最近更新时间:2022-08-12 09:09:34

我的收藏

1. 接口描述

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

根据条件查询 Prometheus 预聚合规则

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeRecordingRules。
Version String 公共参数,本接口取值:2018-07-24。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-mumbai, ap-nanjing, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, eu-moscow, na-ashburn, na-siliconvalley, sa-saopaulo 。
InstanceId String Prometheus 实例 ID
Limit Integer 返回数量,默认为 20,最大值为 100
Offset Integer 偏移量,默认为 0
RuleId String 规则 ID
RuleState Integer 规则状态码,取值如下:
  • 1=RuleDeleted
  • 2=RuleEnabled
  • 3=RuleDisabled
  • Name String 规则名称

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 规则组数量
    RecordingRuleSet Array of RecordingRuleSet 规则组详情
    注意:此字段可能返回 null,表示取不到有效值。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询预聚合规则

    输入示例

    POST / HTTP/1.1
    Host: monitor.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeRecordingRules
    <公共请求参数>
    
    {
        "InstanceId": "prom-sdf342",
        "RuleState": "2",
        "Limit": "10"
    }

    输出示例

    {
        "Response": {
            "RecordingRuleSet": [
                {
                    "RuleId": "rrule-45hkgiyc",
                    "RuleState": 2,
                    "Name": "example6",
                    "Group": "LS0tDQpuYW1lOiBleGFtcGxlDQpydWxlczoNCiAgLSByZWNvcmQ6IGpvYjpodHRwX2lucHJvZ3Jlc3NfcmVxdWVzdHM6c3VtDQogICAgZXhwcjogc3VtIGJ5IChqb2IpIChodHRwX2lucHJvZ3Jlc3NfcmVxdWVzdHMp",
                    "Total": 1,
                    "UpdatedAt": "2020-08-10T17:50:06Z",
                    "CreatedAt": "2020-08-10T09:32:51Z"
                }
            ],
            "RequestId": "-1y24pm54antkuiziyii7hxwv2974riq",
            "TotalCount": 1
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

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