文档

PutEventRule - 创建或修改事件的报警规则

更新时间:

调用PutEventRule接口创建或修改事件的报警规则。

接口说明

如果报警规则名称不存在,则创建新的报警规则;如果报警规则名称存在,则修改已有报警规则。

本文将提供一个示例,为云服务ecs创建一条事件报警规则myRuleName

调试

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

授权信息

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

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

请求参数

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

事件报警规则名称。

myRuleName
GroupIdstring

事件报警规则所属的应用分组 ID。

7378****
EventTypestring

事件报警规则的类型。取值:

  • SYSTEM:系统事件。
  • CUSTOM:自定义事件。
SYSTEM
Descriptionstring

事件报警规则的描述。

事件报警测试
Statestring

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

  • ENABLED:启用。
  • DISABLED:禁用。
ENABLED
EventPatternobject []

事件报警规则的模式。

EventTypeListarray

事件报警规则的类型。N 的取值范围:1~50。取值:

  • StatusNotification:故障通知。

  • Exception:异常。

  • Maintenance:运维。

  • *:无限制。

string

事件报警规则的类型。N 的取值范围:1~50。取值:

  • StatusNotification:故障通知。

  • Exception:异常。

  • Maintenance:运维。

  • *:无限制。

Exception
StatusListarray

事件报警规则的状态。N 的取值范围:1~50。

string

事件报警规则的状态。N 的取值范围:1~50。

Failed
Productstring

云服务类型。N 的取值范围:1~50。

说明 关于事件报警规则支持的云服务,请参见 DescribeSystemEventMetaList
ecs
LevelListarray

事件报警规则的等级。N 的取值范围:1~50。取值:

  • CRITICAL:严重。

  • WARN:警告。

  • INFO:信息。

  • *:所有等级。

string

事件报警规则的等级。N 的取值范围:1~50。取值:

  • CRITICAL:严重。

  • WARN:警告。

  • INFO:信息。

  • *:所有等级。

CRITICAL
NameListarray

事件报警规则的名称。N 的取值范围:1~50。

string

事件报警规则的名称。N 的取值范围:1~50。

Agent_Status_Stopped
CustomFiltersstring

事件过滤关键字。当事件内容包含该关键字时,自动触发报警。

Stopping
SQLFilterstring

SQL 事件过滤。当事件内容满足 SQL 条件时,自动触发报警。

说明 SQL 事件过滤的语法与日志服务 SLS 的查询语法保持一致。
192.168.XX.XX and Executed
SilenceTimelong

通道沉默时间。单位:秒。

86400

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

返回参数

名称类型描述示例值
object
Codestring

状态码。

说明 200 表示成功。
200
Messagestring

错误信息。

The Request is not authorization.
Datastring

创建或修改事件报警规则时,返回影响的行数。

1
RequestIdstring

请求 ID。

0B47C47B-E68A-4429-BB23-370E91889C7D
Successboolean

操作是否成功。取值:

  • true:成功。

  • false:失败。

true

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "The Request is not authorization.",
  "Data": "1",
  "RequestId": "0B47C47B-E68A-4429-BB23-370E91889C7D",
  "Success": true
}

错误码

HTTP status code错误码错误信息
400%s%s
500InternalErrorThe request processing has failed due to some unknown error.

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

变更历史

变更时间变更内容概要操作
2021-12-24OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:500