1 つのグローバル アラート構成を取得
GLOBAL-ALERT-CONFIG-ID
で識別される 1 つのグローバル アラート構成を取得します。
必須のロール
割り当てられた次のいずれかのロールを使用して、このエンドポイントを正常に呼び出すことができます。
リクエスト
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /globalAlertConfigs/{GLOBAL-ALERT-CONFIG-ID}
リクエスト パス パラメーター
名前 | タイプ | 必要性 | 説明 |
---|---|---|---|
{GLOBAL-ALERT-CONFIG-ID} | string | 必須 | 検索対象のグローバル アラート構成の一意の識別子。 |
リクエスト クエリ パラメータ
名前 | タイプ | 必要性 | 説明 | default | ||||||
---|---|---|---|---|---|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。 | false | ||||||
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
| false |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
名前 | タイプ | 説明 |
---|---|---|
created | string | ISO8601 のタイムスタンプ アラート構成が作成されたときの UTC の日付と時刻形式。 |
enabled | ブール値 | アラート構成が有効かどうかを指定するトグル。 |
eventTypeName | string | このアラート構成がアラートをトリガーするイベントのタイプ。 アラートを生成するイベントの種類を確認するには、「アラートのタイプ 」を参照してください。 MongoDB Ops Managerの監査ログに含まれるイベントの完全なリストについては、「監査イベント 」を参照してください。 |
forAllGroups | ブール値 | グローバル アラート構成をすべてのグループに適用するかどうかを指定するトグル。 また、
|
groupIds | 文字列の配列 | このアラート構成が適用されるグループの ID。 このフィールドは、 forAllGroups がfalse に設定されている場合にのみ適用されます。 |
id | string | アラート構成の一意の識別子です。 |
matchers | オブジェクトの配列 | このグローバル アラート構成に対してオブジェクトを照合するときに適用するルール。 MongoDB Ops Managerは、 アラート条件のこれらすべてのルールに一致するエンティティのみをチェックします。
|
matchers.fieldName | string | 一致するターゲット オブジェクト内のフィールドの名前。
他のタイプのアラートはすべてマッチャーをサポートしていません。 |
matchers.operator | string | Operator to test the field's value. 可能な値は次のとおりです。
|
matchers.value | string | 指定された演算子でテストする値。
|
metricThreshold | オブジェクト | このアラート構成でアラートをtriggerするしきい値。 eventTypeName がOUTSIDE_METRIC_THRESHOLD に設定されている場合にのみ存在します。 |
metricThreshold.metricName | string | 確認するメトリクスの名前。 globalAlerts リソースのmetricName フィールドと同じ値をサポートします。 可能な値のリストについては、「グローバル アラートの測定タイプ 」を参照してください。 |
metricThreshold.mode | string | これを AVERAGE に設定し、現在のメトリクス値を平均として計算します。 |
metricThreshold.operator | string | 現在のメトリクス値を
|
metricThreshold.threshold | 数値 | このアラート構成でアラートがトリガーされるしきい値。 |
metricThreshold.units | string |
指定できる値は次のとおりです。
例、メモリ消費を測定するメトリクスには |
notifications | オブジェクトの配列 | このアラート構成が記述するアラートを検出したときに MongoDB Ops Manager が送信する通知。 |
notifications.apiToken | string | Slack API トークンまたは Bot トークン。 API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。
|
notifications.channelName | string | Slack チャンネル名。 SLACK 通知にのみ存在します。 |
notifications.delayMin | 数値 | アラート条件 が検出された後、MongoDB Ops Manager が最初の通知を送信するまでに待機する時間(分)。 |
notifications.emailAddress | string | 通知を送信するメールアドレス。 EMAIL 通知にのみ存在します。 |
notifications.emailEnabled | ブール値 | MongoDB Ops Managerがメール通知を送信するかどうかを切り替えます。 GROUP とUSER の通知にのみ存在します。 |
notifications.intervalMin | 数値 | このアラート構成がトリガーする未確認、未解決のアラートの連続した通知間で待機する時間(分)。 |
notifications.[n] .webhookSecret | string | 通知を受け入れ、転送する Webhook で認証するために使用される値。
Webhook 通知の作成後、アラートを表示または編集すると、URL が部分的に編集され、シークレットは完全に伏字化されます。 |
notifications.[n] .webhookUrl | string | この通知をトリガーする Webhook のURL 。
Webhook 通知の作成後、アラートを表示または編集すると、URL が部分的に編集され、シークレットは完全に伏字化されます。 |
notifications.microsoftTeamsWebhookUrl | string | Microsoft Teams チャネルの受信 Webhook URL 。 Webhook 通知のアラートを表示または編集すると、URL が部分的に編集され、シークレットは完全に伏字化された状態で表示されます。 |
notifications.notificationToken | string | HipChat API トークン。 API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。
|
notifications.roomName | string | HipChat ルーム名。 HIP_CHAT 通知にのみ存在します。 |
notifications.serviceKey | string | PagerDuty 統合キー。 API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。
|
notifications.smsEnabled | ブール値 | MongoDB Ops Managerが SMS 通知を送信するかどうかを切り替えます。 GROUP とUSER の通知にのみ存在します。 |
notifications.typeName | string | このアラート構成トリガーのアラート通知のタイプ。 可能な値は次のとおりです。
|
notifications.username | string | 通知を送信する MongoDB Ops Manager ユーザーの名前。 USER 通知にのみ存在します。 |
threshold | オブジェクト | このアラート構成でアラートをtriggerするしきい値。
|
threshold.operator | string | 現在のメトリクス値を
|
threshold.threshold | 数値 | このアラート構成でアラートがトリガーされるしきい値。 |
tags | 文字列の配列 | このアラート構成に関連付けられているタグ。 |
typeName | string | このフィールドは非推奨であり、無視されます。 |
updated | string | ISO8601 のタイムスタンプ このアラート構成が最後に更新されたときの UTC の日付と時刻形式。 |
リクエストの例
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ 2 --header "Accept: application/json" \ 3 --include \ 4 --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/globalAlertConfigs/{GLOBAL-ALERT-CONFIG-ID}"
応答例
応答ヘッダー
401 Unauthorized Content-Type: application/json;charset=ISO-8859-1 Date: {dateInUnixFormat} WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false Content-Length: {requestLengthInBytes} Connection: keep-alive
200 OK Vary: Accept-Encoding Content-Type: application/json Strict-Transport-Security: max-age=300 Date: {dateInUnixFormat} Connection: keep-alive Content-Length: {requestLengthInBytes} X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
レスポンス本体
1 { 2 "created": "2019-10-02T12:34:04Z", 3 "enabled": true, 4 "eventTypeName": "BACKUP_AGENT_DOWN", 5 "forAllGroups": true, 6 "groupIds": [], 7 "id": "{GLOBAL-ALERT-CONFIG-ID}", 8 "links": [ 9 ], 10 "matchers": [], 11 "notifications": [ 12 { 13 "delayMin": 0, 14 "intervalMin": 60, 15 "typeName": "ADMIN" 16 } 17 ], 18 "tags": [], 19 "typeName": "AGENT", 20 "updated": "2019-10-02T12:34:04Z" 21 }