云产品指标

输入关键词搜索相关文档

获取基础策略告警组列表

最近更新时间:2021-02-04 08:26:28

我的收藏

1. 接口描述

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

获取基础策略告警组列表

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:monitor.ap-shanghai-fsi.tencentcloudapi.com。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribePolicyGroupList。
Version String 公共参数,本接口取值:2018-07-24。
Region String 公共参数,详见产品支持的 地域列表
Module String 固定值,为"monitor"
Limit Integer 分页参数,每页返回的数量,取值1~100
Offset Integer 分页参数,页偏移量,从0开始计数
Like String 按策略名搜索
InstanceGroupId Integer 实例分组id
UpdateTimeOrder String 按更新时间排序, asc 或者 desc
ProjectIds.N Array of Integer 项目id列表
ViewNames.N Array of String 告警策略类型列表
FilterUnuseReceiver Integer 是否过滤无接收人策略组, 1表示过滤, 0表示不过滤
Receivers.N Array of String 过滤条件, 接收组列表
ReceiverUserList.N Array of String 过滤条件, 接收人列表
Dimensions String 维度组合字段(json字符串), 例如[[{"name":"unInstanceId","value":"ins-6e4b2aaa"}]]
ConditionTempGroupId String 模板策略组id, 多个id用逗号分隔
ReceiverType String 过滤条件, 接收人或者接收组, user表示接收人, group表示接收组
IsOpen Boolean 过滤条件,告警策略是否已启动或停止

3. 输出参数

参数名称 类型 描述
GroupList Array of DescribePolicyGroupListGroup 策略组列表
注意:此字段可能返回 null,表示取不到有效值。
Total Integer 策略组总数
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取头两个基础策略告警组列表

输入示例

https://monitor.tencentcloudapi.com/?Action=DescribePolicyGroupList
&Module=monitor
&Limit=2
&Offset=0
&<公共请求参数>

输出示例

{
  "Response": {
    "GroupList": [
      {
        "CanSetDefault": true,
        "Conditions": [
          {
            "AlarmNotifyPeriod": 86400,
            "AlarmNotifyType": 0,
            "CalcType": 1,
            "CalcValue": "0",
            "ContinueTime": 60,
            "MetricId": 33,
            "MetricShowName": "CPU利用率",
            "Period": 60,
            "RuleId": 1111111,
            "Unit": "%"
          }
        ],
        "ConditionsTemp": null,
        "EventConditions": [
          {
            "AlarmNotifyPeriod": 0,
            "AlarmNotifyType": 0,
            "EventId": 42,
            "EventShowName": "ping不可达",
            "RuleId": 1111112
          }
        ],
        "GroupId": 1111111,
        "GroupName": "复制-test",
        "InsertTime": 1531122504,
        "InstanceGroup": null,
        "IsDefault": 0,
        "IsOpen": true,
        "LastEditUin": "1500000000",
        "NoShieldedSum": 0,
        "ParentGroupId": 0,
        "ProjectId": 0,
        "ReceiverInfos": [
          {
            "EndTime": 86400,
            "NeedSendNotice": 1,
            "NotifyWay": [
              "EMAIL",
              "SMS"
            ],
            "PersonInterval": 60,
            "ReceiverGroupList": [
              1111
            ],
            "ReceiverType": "group",
            "ReceiverUserList": [],
            "RecoverNotify": [
              "SMS"
            ],
            "RoundInterval": 60,
            "RoundNumber": 2,
            "SendFor": [],
            "StartTime": 0,
            "UidList": null
          }
        ],
        "Remark": "",
        "UpdateTime": 1577689096,
        "UseSum": 0,
        "ViewName": "cvm_device"
      },
      {
        "CanSetDefault": false,
        "Conditions": [
          {
            "AlarmNotifyPeriod": 0,
            "AlarmNotifyType": 0,
            "CalcType": 1,
            "CalcValue": "0.85",
            "ContinueTime": 300,
            "MetricId": 1220,
            "MetricShowName": "磁盘使用百分比",
            "Period": 60,
            "RuleId": 1111113,
            "Unit": ""
          }
        ],
        "ConditionsTemp": null,
        "EventConditions": null,
        "GroupId": 1111112,
        "GroupName": "默认",
        "InsertTime": 1565792922,
        "InstanceGroup": null,
        "IsDefault": 1,
        "IsOpen": true,
        "LastEditUin": "1500000687",
        "NoShieldedSum": 1,
        "ParentGroupId": 0,
        "ProjectId": 0,
        "ReceiverInfos": null,
        "Remark": "",
        "UpdateTime": 1565792922,
        "UseSum": 1,
        "ViewName": "CKAFKA_INSTANCE"
      }
    ],
    "RequestId": "5fdf1257-6024-4b59-b924-2b995080f0bd",
    "Total": 142
  }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure.UnauthorizedOperation 请求未授权。请参考 CAM 文档对鉴权的说明。
DryRunOperation DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。
FailedOperation 操作失败。
FailedOperation.AlertFilterRuleDeleteFailed 删除过滤条件失败。
FailedOperation.AlertPolicyCreateFailed 创建告警策略失败。
FailedOperation.AlertPolicyDeleteFailed 告警策略删除失败。
FailedOperation.AlertPolicyDescribeFailed 告警策略查询失败。
FailedOperation.AlertPolicyModifyFailed 告警策略修改失败。
FailedOperation.AlertTriggerRuleDeleteFailed 删除触发条件失败。
FailedOperation.DbQueryFailed 数据库查询失败。
FailedOperation.DbRecordCreateFailed 创建数据库记录失败。
FailedOperation.DbRecordDeleteFailed 数据库记录删除失败。
FailedOperation.DbRecordUpdateFailed 数据库记录更新失败。
FailedOperation.DbTransactionBeginFailed 数据库事务开始失败。
FailedOperation.DbTransactionCommitFailed 数据库事务提交失败。
FailedOperation.DimQueryRequestFailed 请求维度查询服务失败。
FailedOperation.DruidQueryFailed 查询分析数据失败。
FailedOperation.DuplicateName 名字重复。
FailedOperation.ServiceNotEnabled 服务未启用,开通服务后方可使用。
InternalError 内部错误。
InternalError.ExeTimeout 执行超时。
InvalidParameter 参数错误。
InvalidParameter.InvalidParameter 参数错误。
InvalidParameter.InvalidParameterParam 参数错误。
InvalidParameterValue 参数取值错误。
LimitExceeded 超过配额限制。
LimitExceeded.MetricQuotaExceeded 指标数量达到配额限制,禁止含有未注册指标的请求。
MissingParameter 缺少参数错误。
ResourceInUse 资源被占用。
ResourceInsufficient 资源不足。
ResourceNotFound 资源不存在。
ResourceUnavailable 资源不可用。
ResourcesSoldOut 资源售罄。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。
目录