Docs Menu
Docs Home
/
MongoDB Ops Manager
/
API
/
MongoDB Ops Manager Administration APIリソース
/
測定値とアラート
/
グローバル アラート構成

すべてのグローバル アラート構成を取得する

項目一覧

  • 必須のロール
  • リクエスト
  • リクエスト パス パラメーター
  • リクエスト クエリ パラメータ
  • リクエスト ボディ パラメータ
  • 応答
  • 応答ドキュメント
  • results embeddedDocument
  • リクエストの例
  • 応答例
  • 応答ヘッダー
  • レスポンス本体

すべてのグローバル アラート構成を取得します。

必須のロール

割り当てられた次のいずれかのロールを使用して、このエンドポイントを正常に呼び出すことができます。

リクエスト

ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

GET /globalAlertConfigs

リクエスト パス パラメーター

このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。

リクエスト クエリ パラメータ

名前
タイプ
必要性
説明
default
pageNum
数値
任意
結果のサブセクションを返す 1 から始まる整数。
1
itemsPerPage
数値
任意
1 ページあたりに返す項目の数は最大 500 です。
100
pretty
ブール値
任意
レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。
false
envelope
ブール値
任意

応答をエンベロープでラップするかどうかを示すフラグ。

一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope : trueを設定します。

結果のリストを返すエンドポイントの場合、 resultsオブジェクトはエンベロープです。 MongoDB Ops Manager は、レスポンス本体にstatusフィールドを追加します。

false
backupJobsEnabledOnly
ブール値
任意
データベースのバックアップ用に有効になっていないデーモンを応答から除外するかどうかを示すフラグ。 これをfalseに設定し、 backupJobsEnabledフラグがfalseに設定されているデーモン構成を含めます。
true

リクエスト ボディ パラメータ

このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。

応答

応答ドキュメント

レスポンスJSONドキュメントには、 resultオブジェクトの配列、 linkオブジェクトの配列、および取得されたresultオブジェクトの合計数が含まれます。

名前
タイプ
説明
results
配列
配列には、 results埋め込みドキュメントセクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。
links
配列
配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様 で説明されています。
totalCount
数値
結果セット内の項目の合計数の整数。 結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。

results embeddedDocument

各結果は 1 つのアラート構成です。

名前
タイプ
説明
created
string
ISO8601 のタイムスタンプ アラート構成が作成されたときの UTC の日付と時刻形式。
enabled
ブール値
アラート構成が有効かどうかを指定するトグル。
eventTypeName
string

このアラート構成がアラートをトリガーするイベントのタイプ。

アラートを生成するイベントの種類を確認するには、「アラートのタイプ 」を参照してください。

MongoDB Ops Managerの監査ログに含まれるイベントの完全なリストについては、「監査イベント 」を参照してください。

forAllGroups
ブール値

グローバル アラート構成をすべてのグループに適用するかどうかを指定するトグル。 また、 tags配列を使用して構成を特定のグループをターゲットにするかどうかにも影響します。

trueの場合、構成はすべてのグループに適用されます。 tags配列を使用して、アラート構成を特定のグループにターゲットにすることができます。

falseの場合、構成はgroupIds配列で指定されたグループにのみ適用されます。 groupIds配列には少なくとも 1 つのプロジェクトを指定する必要があります。 このアラート構成では、 tags配列は使用できません。

groupIds
文字列の配列
このアラート構成が適用されるグループの ID。 このフィールドは、 forAllGroupsがfalseに設定されている場合にのみ適用されます。
id
string
アラート構成の一意の識別子です。
matchers
オブジェクトの配列

このグローバル アラート構成に対してオブジェクトを照合するときに適用するルール。 MongoDB Ops Managerは、 アラート条件のこれらすべてのルールに一致するエンティティのみをチェックします。

eventTypeNameがホスト、レプリカセット、またはシャーディングされたクラスターのイベントを指定している場合にのみ、 matchers配列を使用してフィルタリングできます。

matchers.fieldName
string

一致するターゲット オブジェクト内のフィールドの名前。

  • ホスト アラートは、次のフィールドをサポートします。

    • HOSTNAME

    • PORT

    • HOSTNAME_AND_PORT

    • REPLICA_SET_NAME

    • TYPE_NAME

  • レプリカセット アラートは次のフィールドをサポートします。

    • REPLICA_SET_NAME

    • SHARD_NAME

    • CLUSTER_NAME

  • シャーディングされたクラスター アラートは、次のフィールドをサポートします。

    • CLUSTER_NAME

    • SHARD_NAME

他のタイプのアラートはすべてマッチャーをサポートしていません。

matchers.operator
string

Operator to test the field's value. 可能な値は次のとおりです。

  • EQUALS

  • NOT_EQUALS

  • CONTAINS

  • NOT_CONTAINS

  • STARTS_WITH

  • ENDS_WITH

  • REGEX

matchers.value
string

指定された演算子でテストする値。

matchers.fieldNameがTYPE_NAMEに設定されている場合は、次の値を照合できます。

  • PRIMARY

  • SECONDARY

  • STANDALONE

  • CONFIG

  • MONGOS

metricThreshold
オブジェクト
このアラート構成でアラートをtriggerするしきい値。 eventTypeNameがOUTSIDE_METRIC_THRESHOLDに設定されている場合にのみ存在します。
metricThreshold.metricName
string
確認するメトリクスの名前。 globalAlertsリソースのmetricNameフィールドと同じ値をサポートします。 可能な値のリストについては、「グローバル アラートの測定タイプ 」を参照してください。
metricThreshold.mode
string
これをAVERAGEに設定し、現在のメトリクス値を平均として計算します。
metricThreshold.operator
string

現在のメトリクス値をmetricThreshold.thresholdと照合するときに適用する演算子。 可能な値は次のとおりです。

  • GREATER_THAN

  • LESS_THAN

metricThreshold.threshold
数値
このアラート構成でアラートがトリガーされるしきい値。
metricThreshold.units
string

metricThreshold.thresholdの単位。 単位はメトリクスの型によって異なります。

指定できる値は次のとおりです。

  • RAW

  • BITS

  • BYTES

  • KILOBITS

  • KILOBYTES

  • MEGABITS

  • MEGABYTES

  • GIGABITS

  • GIGABYTES

  • TERABYTES

  • PETABYTES

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

例、メモリ消費を測定するメトリクスにはBYTESを使用でき、時間を測定するメトリクスにはHOURSを使用できます。

notifications
オブジェクトの配列
このアラート構成が記述するアラートを検出したときに MongoDB Ops Manager が送信する通知。
notifications.apiToken
string

Slack API トークンまたは Bot トークン。 SLACK通知にのみ存在します。 後でトークンが無効になった場合、 MongoDB Ops Managerはプロジェクト所有者にメールを送信し、トークンを削除します。

API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。

  • UI を通じてアラートを表示または編集します。

  • 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 で認証するために使用される値。

notifications.[n].typeNameをWEBHOOKに設定し、次のいずれかを実行すると、MongoDB Ops Manager はこの値を返します。

  • notification.[n].webhookSecret に空でないstringを設定した場合

  • 管理コンソールでデフォルトのwebhookSecretを設定します。

Webhook 通知の作成後、アラートを表示または編集すると、URL が部分的に編集され、シークレットは完全に伏字化されます。

notifications.[n]
.webhookUrl
string

この通知をトリガーする Webhook のURL 。

notifications.[n].typeNameをWEBHOOKに設定し、次のいずれかを実行すると、MongoDB Ops Manager はこの値を返します。

  • notification.[n].webhookURL に空でないstringを設定した場合

  • 管理コンソールページでデフォルトのwebhookUrlを設定します。

Webhook 通知の作成後、アラートを表示または編集すると、URL が部分的に編集され、シークレットは完全に伏字化されます。

notifications.microsoftTeamsWebhookUrl
string

Microsoft Teams チャネルの受信 Webhook URL 。 MICROSOFT_TEAMS通知にのみ存在します。

Webhook 通知のアラートを表示または編集すると、URL が部分的に編集され、シークレットは完全に伏字化された状態で表示されます。

notifications.notificationToken
string

HipChat API トークン。 HIP_CHAT通知にのみ存在します。 後でトークンが無効になった場合、 MongoDB Ops Managerはプロジェクト所有者にメールを送信し、トークンを削除します。

API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。

  • UI を通じてアラートを表示または編集します。

  • APIを介してサードパーティ統合設定をクエリします。

notifications.roomName
string
HipChat ルーム名。 HIP_CHAT通知にのみ存在します。
notifications.serviceKey
string

PagerDuty 統合キー。 PAGER_DUTY通知にのみ存在します。 後でキーが無効になった場合、 MongoDB Ops Managerはプロジェクト所有者にメールを送信し、キーを削除します。

API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。

  • UI を通じてアラートを表示または編集します。

  • APIを介してサードパーティ統合設定をクエリします。

notifications.smsEnabled
ブール値
MongoDB Ops Managerが SMS 通知を送信するかどうかを切り替えます。 GROUPとUSERの通知にのみ存在します。
notifications.snmpAddress
string

SNMP ラップを送信するホスト名とポート。 現時点では、 MongoDB Ops Managerは標準の SNMP ポート（162）にのみ SNMP マップを送信できます。 SNMP通知にのみ存在します。

重要

MongoDB Ops Manager 6.0.0 はSNMPアラートを廃止します。 MongoDB Ops Manager 7.0.0 にはSNMPアラートは含まれません。 その他のアラート オプションの詳細については、「サードパーティ サービスの統合 」を参照してください。

注意

MongoDB Ops Managerは SNMP v2c を使用します。

notifications.typeName
string

このアラート構成トリガーのアラート通知のタイプ。 可能な値は次のとおりです。

notifications.username
string
通知を送信する MongoDB Ops Manager ユーザーの名前。 USER通知にのみ存在します。
threshold
オブジェクト

このアラート構成でアラートをtriggerするしきい値。 eventTypeNameが次のいずれかの値に設定されている場合にのみ存在します。

  • TOO_FEW_HEALTHY_MEMBERS

  • TOO_MANY_UNHEALTHY_MEMBERS

threshold.operator
string

現在のメトリクス値をthreshold.thresholdと照合するときに適用する演算子。 可能な値は次のとおりです。

  • GREATER_THAN

  • LESS_THAN

threshold.threshold
数値
このアラート構成でアラートがトリガーされるしきい値。
tags
文字列の配列
このアラート構成に関連付けられているタグ。
typeName
string
このフィールドは非推奨であり、無視されます。
updated
string
ISO8601 のタイムスタンプ このアラート構成が最後に更新されたときの UTC の日付と時刻形式。

リクエストの例

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2     --header "Accept: application/json" \
3     --include \
4     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/globalAlertConfigs"

応答例

応答ヘッダー

HTTP/1.1 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
HTTP/1.1 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  "links": [
3  ],
4  "results": [
5    {
6      "created": "2019-10-02T12:34:04Z",
7      "enabled": true,
8      "eventTypeName": "RS_BIND_ERROR",
9      "forAllGroups": true,
10      "groupIds": [],
11      "id": "{GLOBAL-ALERT-CONFIG-ID}",
12      "links": [
13      ],
14      "matchers": [],
15      "notifications": [
16        {
17          "delayMin": 0,
18          "intervalMin": 60,
19          "typeName": "ADMIN"
20        }
21      ],
22      "tags": [],
23      "typeName": "BACKUP",
24      "updated": "2019-10-02T12:34:04Z"
25    },
26    {
27      "created": "2019-10-02T12:34:04Z",
28      "enabled": true,
29      "eventTypeName": "BACKUP_TOO_MANY_RETRIES",
30      "forAllGroups": true,
31      "groupIds": [],
32      "id": "{GLOBAL-ALERT-CONFIG-ID}",
33      "links": [
34      ],
35      "matchers": [],
36      "notifications": [
37        {
38          "delayMin": 0,
39          "intervalMin": 60,
40          "typeName": "ADMIN"
41        }
42      ],
43      "tags": [],
44      "typeName": "BACKUP",
45      "updated": "2019-10-02T12:34:04Z"
46    },
47    {
48      "created": "2019-10-02T12:34:04Z",
49      "enabled": true,
50      "eventTypeName": "BACKUP_IN_UNEXPECTED_STATE",
51      "forAllGroups": true,
52      "groupIds": [],
53      "id": "{GLOBAL-ALERT-CONFIG-ID}",
54      "links": [
55      ],
56      "matchers": [],
57      "notifications": [
58        {
59          "delayMin": 0,
60          "intervalMin": 60,
61          "typeName": "ADMIN"
62        }
63      ],
64      "tags": [],
65      "typeName": "BACKUP",
66      "updated": "2019-10-02T12:34:04Z"
67    }
68  ],
69  "totalCount": 3
70}

戻る

グローバル アラート構成

次へ

1 つのグローバル アラート構成によってトリガーされるすべてのオープン アラートを取得する