操作指南

API 文档

云产品监控指标

文档中心 > 云监控 > API 文档 > 告警相关接口 > 查询告警策略列表(支持按实例等条件筛选)

查询告警策略列表(支持按实例等条件筛选)

最近更新时间:2022-05-13 06:15:15

我的收藏

1. 接口描述

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

查询告警策略列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeAlarmPolicies。
Version String 公共参数,本接口取值:2018-07-24。
Region String 公共参数,详见产品支持的 地域列表
Module String 固定值,为"monitor"
PageNumber Integer 页数,从 1 开始计数,默认 1
PageSize Integer 每页的数量,取值1~100,默认20
PolicyName String 按策略名称模糊搜索
MonitorTypes.N Array of String 根据监控类型过滤 不选默认查所有类型 "MT_QCE"=云产品监控
Namespaces.N Array of String 根据命名空间过滤,不同策略类型的值详见
策略类型列表
Dimensions String 告警对象列表,JSON 字符串。外层数组,对应多个实例,内层为对象的维度。例如“云服务器-基础监控”可写为:
[ {"Dimensions": {"unInstanceId": "ins-qr8d555g"}}, {"Dimensions": {"unInstanceId": "ins-qr8d555h"}} ]
具体也可以参考下方的示例 2。

不同云产品参数示例详见 维度信息Dimensions列表

注意:如果NeedCorrespondence传入1,即需要返回策略与实例对应关系,请传入不多于20个告警对象维度,否则容易请求超时
ReceiverUids.N Array of Integer 根据接收人搜索,可以使用“访问管理”的 拉取子用户 ListUsers 接口获取用户列表 或 查询子用户 GetUser 接口查询子用户详情,此处填入返回结果中的 Uid 字段
ReceiverGroups.N Array of Integer 根据接收组搜索,可以使用“访问管理”的 查询用户组列表 ListGroups 接口获取用户组列表 或 列出用户关联的用户组 ListGroupsForUser 查询某个子用户所在的用户组列表 ,此处填入返回结果中的 GroupId 字段
PolicyType.N Array of String 根据默认策略筛选 不传展示全部策略 DEFAULT=展示默认策略 NOT_DEFAULT=展示非默认策略
Field String 排序字段,例如按照最后修改时间排序,Field: "UpdateTime"
Order String 排序顺序:升序:ASC 降序:DESC
ProjectIds.N Array of Integer 策略所属项目的id数组,可在此页面查看
项目管理
NoticeIds.N Array of String 通知模版的id列表,可查询通知模版列表获取。
可使用 查询通知模板列表 接口查询。
RuleTypes.N Array of String 根据触发条件筛选 不传展示全部策略 STATIC=展示静态阈值策略 DYNAMIC=展示动态阈值策略
Enable.N Array of Integer 告警启停筛选,[1]:启用 [0]:停止,全部[0, 1]
NotBindingNoticeRule Integer 传 1 查询未配置通知规则的告警策略;不传或传其他数值,查询所有策略。
InstanceGroupId Integer 实例分组id
NeedCorrespondence Integer 是否需要策略与入参过滤维度参数的对应关系,1:是 0:否,默认为0
TriggerTasks.N Array of AlarmPolicyTriggerTask 按照触发任务(例如弹性伸缩)过滤策略。最多10个
OneClickPolicyType.N Array of String 根据一键告警策略筛选 不传展示全部策略 ONECLICK=展示一键告警策略 NOT_ONECLICK=展示非一键告警策略

3. 输出参数

参数名称 类型 描述
TotalCount Integer 策略总数
Policies Array of AlarmPolicy 策略数组
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询告警策略列表

输入示例

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

{
    "Module": "monitor",
    "PageSize": 10,
    "PageNumber": 1
}

输出示例

{
  "Response": {
    "Policies": [
      {
        "PolicyId": "policy-pvnj4u7h",
        "PolicyName": "Test-2",
        "UseSum": 0,
        "Remark": "For-Test-2",
        "MonitorType": "MT_QCE",
        "Enable": 1,
        "RuleType": "STATIC",
        "TagInstances": null,
        "IsDefault": 0,
        "ProjectId": 0,
        "ProjectName": "",
        "Namespace": "cvm_device",
        "ConditionTemplateId": "",
        "Condition": {
          "IsUnionRule": 0,
          "Rules": [
            {
              "MetricName": "CpuUsage",
              "Description": "CPU利用率",
              "Period": 60,
              "Operator": "gt",
              "Value": "0",
              "ContinuePeriod": 1,
              "NoticeFrequency": 86400,
              "IsPowerNotice": 0,
              "Filter": {
                "Type": "",
                "Dimensions": "[]"
              }
            }
          ]
        },
        "EventCondition": {
          "Rules": []
        },
        "NoticeIds": [
          "notice-esrwma09"
        ],
        "Notices": [
          {
            "Id": "notice-esrwma09",
            "Name": "Notice-Test-2",
            "UpdatedAt": "2020-10-19 20:56:50",
            "UpdatedBy": "1500000685",
            "NoticeType": "OK",
            "UserNotices": [
              {
                "ReceiverType": "GROUP",
                "UserIds": null,
                "GroupIds": [
                  3877
                ],
                "StartTime": 0,
                "EndTime": 1,
                "NoticeWay": [
                  "EMAIL"
                ],
                "PhoneOrder": null,
                "PhoneCircleTimes": 2,
                "PhoneInnerInterval": 60,
                "PhoneCircleInterval": 60,
                "NeedPhoneArriveNotice": 1
              }
            ],
            "URLNotices": [
              {
                "URL": "https://www.abc.com",
                "IsValid": 0
              }
            ],
            "IsPreset": 0
          }
        ],
        "TriggerTasks": [],
        "OriginId": "1314081",
        "ConditionsTemp": {
          "TemplateName": "",
          "Condition": null,
          "EventCondition": null
        },
        "LastEditUin": "1500000685",
        "UpdateTime": 1603114100,
        "InsertTime": 1603114100,
        "Region": [
          "bj",
          "ca",
          "cd",
          "cq",
          "de",
          "fzec",
          "gz",
          "gzopen",
          "hk",
          "hzec",
          "in",
          "jnec",
          "jp",
          "kr",
          "nj",
          "ru",
          "sg",
          "sh",
          "shjr",
          "szjr",
          "szx",
          "th",
          "tpe",
          "tsn",
          "use",
          "usw"
        ],
        "FilterDimensionsParam": "",
        "NamespaceShowName": "云服务器-基础监控",
        "CanSetDefault": 1,
        "InstanceGroupId": 0,
        "InstanceGroupName": "",
        "InstanceSum": 0
      }
    ],
    "RequestId": "p7gicv4fb-4euztbaaczrsj4vz-s28g-",
    "TotalCount": 1
  }
}

示例2 搜索一个云服务器绑定的告警策略

按照实例过滤策略,需要填入监控类型、策略类型、实例的维度信息。我们以搜索两个云服务器为例,假设他们的实例 ID 分别为 ins-qr8d555g, ins-qr8d555h

MonitorTypes 指定为 MT_QCE

Namespaces 指定为 cvm_device

Dimensions 的 JSON 字符串为

[
    {
        "Dimensions": {
            "unInstanceId": "ins-qr8d555g"
        }
    },
     {
        "Dimensions": {
            "unInstanceId": "ins-qr8d555h"
        }
    }
]

不同云产品参数示例详见 维度信息Dimensions列表

输入示例

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

{
    "Module": "monitor",
    "PageSize": 10,
    "PageNumber": 1,
    "MonitorTypes": [
        "MT_QCE"
    ],
    "Namespaces": [
        "cvm_device"
    ],
    "Dimensions": "[{\"Dimensions\": { \"unInstanceId\": \"ins-qr8d555g\"}},{ \"Dimensions\": { \"unInstanceId\": \"ins-qr8d555h\"}}]"
}

输出示例

{
  "Response": {
    "Policies": [
      {
        "PolicyId": "policy-pvnj4u7h",
        "PolicyName": "Test-2",
        "UseSum": 0,
        "Remark": "For-Test-2",
        "MonitorType": "MT_QCE",
        "Enable": 1,
        "RuleType": "STATIC",
        "TagInstances": null,
        "IsDefault": 0,
        "ProjectId": 0,
        "ProjectName": "",
        "Namespace": "cvm_device",
        "ConditionTemplateId": "",
        "Condition": {
          "IsUnionRule": 0,
          "Rules": [
            {
              "MetricName": "CpuUsage",
              "Description": "CPU利用率",
              "Period": 60,
              "Operator": "gt",
              "Value": "0",
              "ContinuePeriod": 1,
              "NoticeFrequency": 86400,
              "IsPowerNotice": 0,
              "Filter": {
                "Type": "",
                "Dimensions": "[]"
              }
            }
          ]
        },
        "EventCondition": {
          "Rules": []
        },
        "NoticeIds": [
          "notice-esrwma09"
        ],
        "Notices": [
          {
            "Id": "notice-esrwma09",
            "Name": "Notice-Test-2",
            "UpdatedAt": "2020-10-19 20:56:50",
            "UpdatedBy": "1500000685",
            "NoticeType": "OK",
            "UserNotices": [
              {
                "ReceiverType": "GROUP",
                "UserIds": null,
                "GroupIds": [
                  3877
                ],
                "StartTime": 0,
                "EndTime": 1,
                "NoticeWay": [
                  "EMAIL"
                ],
                "PhoneOrder": null,
                "PhoneCircleTimes": 2,
                "PhoneInnerInterval": 60,
                "PhoneCircleInterval": 60,
                "NeedPhoneArriveNotice": 1
              }
            ],
            "URLNotices": [
              {
                "URL": "https://www.abc.com",
                "IsValid": 0
              }
            ],
            "IsPreset": 0
          }
        ],
        "TriggerTasks": [],
        "OriginId": "1314081",
        "ConditionsTemp": {
          "TemplateName": "",
          "Condition": null,
          "EventCondition": null
        },
        "LastEditUin": "1500000685",
        "UpdateTime": 1603114100,
        "InsertTime": 1603114100,
        "Region": [
          "bj",
          "ca",
          "cd",
          "cq",
          "de",
          "fzec",
          "gz",
          "gzopen",
          "hk",
          "hzec",
          "in",
          "jnec",
          "jp",
          "kr",
          "nj",
          "ru",
          "sg",
          "sh",
          "shjr",
          "szjr",
          "szx",
          "th",
          "tpe",
          "tsn",
          "use",
          "usw"
        ],
        "FilterDimensionsParam": "",
        "NamespaceShowName": "云服务器-基础监控",
        "CanSetDefault": 1,
        "InstanceGroupId": 0,
        "InstanceGroupName": "",
        "InstanceSum": 0
      }
    ],
    "RequestId": "p7gicv4fb-4euztbaaczrsj4vz-s28g-",
    "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. 错误码

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

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
UnsupportedOperation 操作不支持。
目录