プロジェクトのアラート構成内の特定の通知方法のテスト通知をトリガーします。このエンドポイントは、Webhook 構成を検証するために、ダミーのデータとレンダリングされたテンプレートを含むテスト ペイロードを送信します。
リクエスト
POST /api/public/v1.0/groups/{GROUP-ID}/alertConfigs/{ALERT-CONFIG-ID}/{NOTIFICATION-ID}/test
リクエスト パス パラメーター
Parameter | タイプ | 説明 |
|---|---|---|
グループ ID | string | プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。 |
ALERT-CONFIG-ID | string | アラート設定を識別する一意の 24 桁の 16 進数文字列です。 |
通知 - ID | string | アラート構成内の通知方法を識別する一意な 24 桁の 16 進数文字列。 |
リクエスト クエリ パラメータ
このエンドポイントは、 HTTPリクエストクエリ パラメーターを使用しません。
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体のパラメータを使用しません。
応答
応答要素
クエリ パラメータ pretty=true を設定すると、応答は 読みやすい形式で表示されます。
Parameter | タイプ | 説明 |
|---|---|---|
成功 | ブール値 | テスト通知が正常に送信されたかどうかを示すフラグ。 |
メッセージ | string | テスト操作の結果を説明する、人間が判読可能なメッセージ。 |
詳細 | オブジェクト | テスト通知に関する追加の詳細。 |
Details.notificationType | string | テストされた通知のタイプ（例: |
Details.d destination | string | テスト通知が送信された宛先。 Webhook の場合、これは Webhook URLです。 |
詳細.timestamp | string | テスト通知が送信されたときの 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" } }