调用PostEmonTryAlarmRule，发送测试的报警消息。
接口说明
此 API 接口每小时最多被调用 10 次。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
elasticsearch:PostEmonTryAlarmRule |
none |
*全部资源
|
无 | 无 |
请求语法
POST /openapi/emon/projects/{ProjectId}/alarm-groups/{AlarmGroupId}/alarm-rules/_test HTTP/1.1路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ProjectId |
string |
是 |
监控报警项目 ID，格式为es- |
es-133071096032**** |
| AlarmGroupId |
string |
是 |
从 GetEmonGrafanaAlerts 接口中获取的报警列表中的 ID 之一。您可以按需求指定具体的 ID。 |
123 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| body |
string |
否 |
测试报警规则、通知方式及消息接收人信息。 |
{"alarmRuleName":"test_rule","AlarmChannel":{"phone":true,"sms":true,"dingWebHook":true},"receivers":[{"id":19,"contactGroup":false}]} |
** RequestBody**
RequestBody 中还需要填入以下参数，用来指定待发送的测试报警消息。
| 参数 | 类型 | 是否必要 | 示例值 | 描述 |
| alarmRuleName | String | 是 | test_rule | 测试的报警规则名称。 |
| AlarmChannel | Object | 是 | 通知方式。 | |
| └phone | Boolean | 否 | true | 是否打电话：true（打电话）、false（不打电话）。 |
| └sms | Boolean | 否 | true | 是否发短信：true（发短信）、false（不发短信）。 |
| └dingWebHook | Boolean | 否 | true | 是否发钉钉消息：true（发钉钉消息）、false（不发钉钉消息）。 |
| receivers | List | 是 | 消息接收人列表。 | |
| └id | long | 是 | 19 | 联系人或者联系人组 ID。 |
| └contactGroup | Boolean | 否 | false | 此 ID 是否是联系人组 ID：true（是联系人组 ID）、false（不是联系人组 ID）。 |
└表示子参数。
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| Code |
string |
响应码。 |
200 |
| Message |
string |
响应消息。 |
"" |
| RequestId |
string |
请求 ID。 |
3EC5731F-0944-4E4F-9DD5-1F976B3FCC3D |
| Success |
boolean |
报警消息是否发送成功：true（发送成功）、 false（发送失败）。 |
true |
示例
正常返回示例
JSON格式
{
"Code": "200",
"Message": "\"\"",
"RequestId": "3EC5731F-0944-4E4F-9DD5-1F976B3FCC3D",
"Success": true
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。