文档

PostEmonTryAlarmRule

更新时间:

调用PostEmonTryAlarmRule,发送测试的报警消息。

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

调试

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

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

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

请求参数

名称

类型

位置

是否必选

示例值

描述

ProjectId String Path es-133071096032****

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

AlarmGroupId String Path 123

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

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

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

RequestBody

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

参数

类型

是否必要

示例值

描述

alarmRuleName

String

test_rule

测试的报警规则名称。

Channel

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)。

说明 └表示子参数。

返回数据

名称

类型

示例值

描述

Code String 200

响应码。

Message String ""

响应消息。

RequestId String 3EC5731F-0944-4E4F-9DD5-1F976B3FCC3D

请求ID。

Success Boolean true

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

示例

请求示例

POST /openapi/emon/projects/es-133071096032****/alarm-groups/123/alarm-rules/_test HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json
{
    "alarmRuleName": "test_alarm_rule", 
    "channel": {
        "sms": true, 
        "dingWebHook": true, 
        "phone": true
    }, 
    "receivers": [
        {
            "id": 33, 
            "contactGroup": true
        }, 
        {
            "id": 19, 
            "contactGroup": false
        }
    ]
}

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<PostEmonTryAlarmRuleResponse>
    <Code>200</Code>
    <Message>""</Message>
    <RequestId>3EC5731F-0944-4E4F-9DD5-1F976B3FCC3D</RequestId>
    <Success>true</Success>
</PostEmonTryAlarmRuleResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Code" : "200",
  "Message" : "",
  "RequestId" : "3EC5731F-0944-4E4F-9DD5-1F976B3FCC3D",
  "Success" : true
}

错误码

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

  • 本页导读 (1)
文档反馈