文档

DescribeEventRuleAttribute - 查询指定事件报警规则的详情

更新时间:

调用DescribeEventRuleAttribute接口查询指定事件报警规则的详情。

接口说明

本文将提供一个示例,查询事件报警规则testRule的详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cms:DescribeEventRuleAttributeRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
RuleNamestring

事件报警规则名称。

关于如何获取事件报警规则名称,请参见 DescribeEventRuleList

testRule
SilenceTimestring

通道沉默周期。

单位:秒,默认值:86400(1 天)。

说明 当监控数据持续超过报警规则阈值时,每个沉默周期内只发送一次报警通知。
86400

关于公共请求参数的详情,请参见公共参数

返回参数

名称类型描述示例值
object
Codestring

状态码。

说明 200 表示成功。
200
Messagestring

错误信息。

The alert does not exist.
RequestIdstring

请求 ID。

9AA3F210-C03D-4C86-8DB6-21C84FF692A1
Successboolean

操作是否成功。取值:

  • true:成功。

  • false:失败。

true
Resultobject

事件报警规则详情。

EventTypestring

事件类型。取值:

  • SYSTEM:系统事件。

  • CUSTOM:自定义事件。

SYSTEM
GroupIdstring

应用分组 ID。

3607****
Namestring

事件报警规则的名称。

test_DefaultEventRule_7378****
Descriptionstring

事件报警规则的描述信息。

Default group event rule.
Statestring

事件报警规则的状态。取值:

  • ENABLED:启用。

  • DISABLED:禁用。

ENABLED
EventPatternobject

事件模式。用于描述事件的触发条件。

Productstring

云产品名称。

CloudMonitor
LevelListarray
string

事件报警规则的级别。取值:

  • CRITICAL:严重。

  • WARN:警告。

  • INFO:信息。

["CRITICAL","WARN"]
StatusListarray
string

事件状态。

Running
NameListarray
string

事件名称。

Agent_Status_Running
EventTypeListarray

事件报警规则的类型列表。

string

事件报警规则的类型。

*表示不限制报警规则类型。

*
SQLFilterstring

按照 SQL 过滤日志。如果符合条件,则触发报警。

ycccluster1 and (i-23ij0o82612 or Executed1) or Asimulated not 222
KeywordFilterObjobject

过滤关键词。

Keywordsarray

事件匹配的关键字列表。

string

关键字。

VMException
Relationstring

多个关键字的条件。取值:

  • OR: 多个关键字之间或的关系。
  • NOT:不包含关键字。表示匹配非关键字列表中的所有事件。
OR

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "The alert does not exist.",
  "RequestId": "9AA3F210-C03D-4C86-8DB6-21C84FF692A1",
  "Success": true,
  "Result": {
    "EventType": "SYSTEM",
    "GroupId": "3607****",
    "Name": "test_DefaultEventRule_7378****",
    "Description": "Default group event rule.",
    "State": "ENABLED",
    "EventPattern": {
      "Product": "CloudMonitor",
      "LevelList": {
        "LevelList": [
          "[\"CRITICAL\",\"WARN\"]    "
        ]
      },
      "StatusList": {
        "StatusList": [
          "Running"
        ]
      },
      "NameList": {
        "NameList": [
          "Agent_Status_Running"
        ]
      },
      "EventTypeList": {
        "EventTypeList": [
          "*"
        ]
      },
      "SQLFilter": "ycccluster1 and (i-23ij0o82612 or Executed1) or Asimulated not 222",
      "KeywordFilterObj": {
        "Keywords": {
          "keyword": [
            "VMException"
          ]
        },
        "Relation": "OR"
      }
    }
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterValueIllegal parameters.参数错误。
403AccessForbiddenUser not authorized to operate on the specified resource.-
404%s%s-
500InternalErrorThe request processing has failed due to some unknown error.-

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-08-31OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:500
出参OpenAPI 返回结构发生变更
2023-03-10OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:500
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈