PostEmonTryAlarmRule_Elasticsearch_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

说明 此 API 接口每小时最多被调用 10 次。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
elasticsearch:PostEmonTryAlarmRule
Get
全部资源
*

请求语法

POST /openapi/emon/projects/{ProjectId}/alarm-groups/{AlarmGroupId}/alarm-rules/_test HTTP/1.1

路径参数

字段名称字段详情
ProjectIdstring

监控报警项目 ID,格式为es-

示例值:es-133071096032****
AlarmGroupIdstring

GetEmonGrafanaAlerts 接口中获取的报警列表中的 ID 之一。您可以按需求指定具体的 ID。

示例值:123

请求参数

字段名称字段详情
bodystring

指定待发送的测试报警消息。

示例值:{ "alarmRuleName": "test_alarm_rule", "channel": { "sms": true, "dingWebHook": true, "phone": true }, "receivers": [ { "id": 33, "contactGroup": true }, { "id": 19, "contactGroup": false } ] }

请求说明

** RequestBody**

RequestBody 中还需要填入以下参数,用来指定待发送的测试报警消息。

参数类型是否必要示例值描述
alarmRuleNameStringtest_rule测试的报警规则名称。
AlarmChannelObject通知方式。
└phoneBooleantrue是否打电话:true(打电话)、false(不打电话)。
└smsBooleantrue是否发短信:true(发短信)、false(不发短信)。
└dingWebHookBooleantrue是否发钉钉消息:true(发钉钉消息)、false(不发钉钉消息)。
receiversList消息接收人列表。
└idlong19联系人或者联系人组 ID。
└contactGroupBooleanfalse此 ID 是否是联系人组 ID:true(是联系人组 ID)、false(不是联系人组 ID)。
说明 └表示子参数。

返回参数

字段名称字段详情
Codestring

响应码。

示例值:200
Messagestring

响应消息。

示例值:""
RequestIdstring

请求 ID。

示例值:3EC5731F-0944-4E4F-9DD5-1F976B3FCC3D
Successboolean

报警消息是否发送成功:true(发送成功)、 false(发送失败)。

示例值:true

返回示例

变更历史

变更时间变更内容概要操作
2022-08-30
删除错误码400

相关示例