調用PostEmonTryAlarmRule,發送測試的報警消息。
調試
您可以在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中還需要填入以下參數,用來指定待發送的測試報警消息。
參數 |
類型 |
是否必要 |
示例值 |
描述 |
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
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。