操作指南

API 文档

云产品监控指标

获取单个告警策略详情

最近更新时间:2022-04-13 06:59:06

我的收藏

1. 接口描述

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

获取单个告警策略详情

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeAlarmPolicy。
Version String 公共参数,本接口取值:2018-07-24。
Region String 公共参数,详见产品支持的 地域列表
Module String 固定值,为"monitor"
PolicyId String 告警策略ID

3. 输出参数

参数名称 类型 描述
Policy AlarmPolicy 策略详情
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询告警策略详情

输入示例

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

{
    "Module": "monitor",
    "PolicyId": "policy-t1pvz47f"
}

输出示例

{
  "Response": {
    "Policy": {
      "PolicyId": "policy-t1pvz47f",
      "PolicyName": "云服务器基础监控告警策略",
      "UseSum": 1,
      "Remark": "",
      "MonitorType": "MT_QCE",
      "Enable": 1,
      "IsDefault": 0,
      "ProjectId": 0,
      "ProjectName": "默认项目",
      "Namespace": "cvm_device",
      "ConditionTemplateId": "",
      "Condition": {
        "IsUnionRule": 0,
        "Rules": [
          {
            "MetricName": "CpuUsage",
            "Description": "CPU利用率",
            "Unit": "%",
            "Period": 60,
            "Operator": "gt",
            "Value": "0",
            "ContinuePeriod": 1,
            "NoticeFrequency": 86400,
            "IsPowerNotice": 0,
            "Filter": {
              "Type": "",
              "Dimensions": "[]"
            },
            "RuleType": ""
          }
        ]
      },
      "EventCondition": {
        "Rules": []
      },
      "NoticeIds": [
        "notice-rwudonte"
      ],
      "Notices": [
        {
          "Id": "notice-rwudonte",
          "Name": "系统预设通知模板",
          "UpdatedAt": "2020-12-04 19:22:30",
          "UpdatedBy": "1500000686",
          "NoticeType": "ALL",
          "UserNotices": [
            {
              "ReceiverType": "USER",
              "UserIds": [
                1001357
              ],
              "GroupIds": null,
              "StartTime": 0,
              "EndTime": 86399,
              "NoticeWay": [
                "SMS",
                "EMAIL"
              ],
              "PhoneOrder": null,
              "PhoneCircleTimes": 0,
              "PhoneInnerInterval": 0,
              "PhoneCircleInterval": 0,
              "NeedPhoneArriveNotice": 0
            }
          ],
          "URLNotices": [],
          "IsPreset": 1,
          "NoticeLanguage": "zh-CN"
        }
      ],
      "TriggerTasks": [],
      "OriginId": "1319514",
      "ConditionsTemp": {
        "TemplateName": "",
        "Condition": null,
        "EventCondition": null
      },
      "LastEditUin": "1500000686",
      "UpdateTime": 1608197675,
      "InsertTime": 1608197675,
      "Region": [
        "bj",
        "ca",
        "cd",
        "cgoec",
        "cq",
        "de",
        "fzec",
        "gz",
        "gzopen",
        "hfeec",
        "hk",
        "hzec",
        "in",
        "jnec",
        "jp",
        "kr",
        "nj",
        "ru",
        "sg",
        "sh",
        "sheec",
        "shjr",
        "szjr",
        "szx",
        "th",
        "tpe",
        "tsn",
        "use",
        "usw",
        "xbec",
        "xiyec"
      ],
      "NamespaceShowName": "云服务器-基础监控",
      "CanSetDefault": 0,
      "InstanceGroupId": 6155,
      "InstanceGroupName": "mingc_instance",
      "InstanceSum": 1,
      "RuleType": "STATIC"
    },
    "RequestId": "546f55d8-80d1-4668-a43e-11490491d62e"
  }
}

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 内部错误。
ResourceNotFound 资源不存在。
UnsupportedOperation 操作不支持。
目录