触发项目警报配置中特定通知方法的测试通知。此端点会发送包含虚拟数据和呈现模板的测试有效负载,以验证 Webhook 配置。
请求
POST /api/public/v1.0/groups/{GROUP-ID}/alertConfigs/{ALERT-CONFIG-ID}/{NOTIFICATION-ID}/test
请求路径参数
Parameter | 类型 | 说明 |
|---|---|---|
群组 ID(group ID) | 字符串 | 用于标识项目的唯一的 24 位十六进制数字字符串。 |
ALERT-CONFIG-ID | 字符串 | 用于标识警报配置的唯一 24 位十六进制数字字符串。 |
NOTIFICATION- ID | 字符串 | 唯一的 24-十六进制数字字符串,用于标识警报配置中的通知方法。 |
请求查询参数
此端点不使用HTTP请求查询参数。
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
响应元素
如果设立查询参数 pretty=true,则响应会以可读格式显示。
Parameter | 类型 | 说明 |
|---|---|---|
Success | 布尔 | 指示测试通知是否已成功发送的标志。 |
message | 字符串 | 描述测试操作结果的人类可读消息。 |
详情 | 对象 | 有关测试通知的其他详细信息。 |
Details.notificationType | 字符串 | 已测试的通知类型(例如, |
Details.destination | 字符串 | 发送测试通知的目标。对于 Webhook,这是 Webhook URL。 |
Details.timestamp | 字符串 | 发送测试通知时的 ISO 8601 时间戳。 |
请求示例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://ops-manager.example.com:8080/api/public/v1.0/groups/{GROUP-ID}/alertConfigs/{ALERT-CONFIG-ID}/{NOTIFICATION-ID}/test?pretty=true"
响应示例
响应标头
200 OK Vary: Accept-Encoding Content-Type: application/json Strict-Transport-Security: max-age=300 Date: {dateInUnixFormat} Connection: keep-alive Content-Length: {requestLengthInBytes}
响应体
{ "success": true, "message": "Test notification sent successfully", "details": { "notificationType": "WEBHOOK", "destination": "https://example.com/webhook", "timestamp": "2025-01-15T10:30:00Z" } }