Body Parameter	タイプ	必要性	説明
`enabled`	ブール値	任意	アラート構成が有効かどうかを指定するトグル。
`eventTypeName`	string	必須	このアラート構成がアラートをトリガーするイベントのタイプ。アラートを生成するイベントの種類を確認するには、「アラートのタイプ」を参照してください。 MongoDB Ops Managerの監査ログに含まれるイベントの完全なリストについては、「監査イベント」を参照してください。
`forAllGroups`	ブール値	必須	グローバルアラート構成をすべてのグループに適用するかどうかを指定するトグル。また、 `tags`配列を使用して構成を特定のグループをターゲットにするかどうかにも影響します。 `true`の場合、構成はすべてのグループに適用されます。 `tags`配列を使用して、アラート構成を特定のグループにターゲットにすることができます。 `false`の場合、構成は`groupIds`配列で指定されたグループにのみ適用されます。 `groupIds`配列には少なくとも 1 つのプロジェクトを指定する必要があります。このアラート構成では、 `tags`配列は使用できません。
`groupIds`	文字列の配列	任意	このアラート構成が適用されるグループの ID。このフィールドは、 `forAllGroups`が`false`に設定されている場合にのみ適用されます。
`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	条件付き	フィールドの値をテストする演算子。指定できる値は以下のとおりです。 `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はプロジェクト所有者にメールを送信し、トークンを削除します。
`notifications` `.channelName`	string	条件付き	Slack チャンネル名。 `SLACK`通知にのみ適用されます。
`notifications` `.delayMin`	数値	条件付き	アラート条件が検出された後、MongoDB Ops Manager が最初の通知を送信するまでに待機する時間（分）。
`notifications` `.emailAddress`	条件付き	任意	通知を送信するメールアドレス。 `EMAIL`通知にのみ適用されます。
`notifications` `.emailEnabled`	ブール値	条件付き	MongoDB Ops Managerがメール通知を送信するかどうかを切り替えます。 `GROUP`と`USER`の通知にのみ適用されます。
`notifications` `.intervalMin`	数値	条件付き	このアラート構成がトリガーする未確認、未解決のアラートの連続した通知間で待機する時間（分）。
`notifications` `.webhookSecret`	string	条件付き	通知を受け入れ、転送する Webhook で認証するために使用される値。シークレットを明示的に宣言できるのは、次の両方を持つリクエストでのみです。 A `notifications.typeName` `WEBHOOK` 明示的に宣言された `notifications.webhookURL` 管理コンソールでのみ、デフォルトの`webhookURL`に`webhookSecret`を構成できます。 `webhookSecret` `webhookURL`を明示的に宣言するには、このフィールドを省略します。
`notifications` `.webhookUrl`	string	任意	この通知をトリガーする Webhook のURL 。 `webhookUrl`を明示的に宣言しない場合、リクエストでは管理コンソールで設定されたデフォルトの`webhookUrl`が使用されます。
`notifications` `.microsoftTeamsWebhookUrl`	string	条件付き	Microsoft Teams チャネルの受信 Webhook URL 。 `MICROSOFT_TEAMS`通知にのみ適用されます。
`notifications` `.notificationToken`	string	条件付き	HipChat API トークン。 `HIP_CHAT`通知にのみ適用されます。後でトークンが無効になった場合、 MongoDB Ops Managerはプロジェクト所有者にメールを送信し、トークンを削除します。
`notifications` `.roomName`	string	条件付き	HipChat ルーム名。 `HIP_CHAT`通知にのみ適用されます。
`notifications` `.serviceKey`	string	条件付き	PagerDuty 統合キー。 `PAGER_DUTY`通知にのみ適用されます。後でキーが無効になった場合、 MongoDB Ops Managerはプロジェクト所有者にメールを送信し、キーを削除します。 PagerDuty REST API v1 キーは 10 月2018 で廃止されました。av1 キーをお持ちの場合は、そのキーをMongoDB Ops Managerで引き続き使用できます。すべての新しい PagerDuty キーはREST API v2 を使用しますが、 MongoDB Ops Manager はv2 キーをサポートしていません。REST API v1キーをお持ちでない場合は、代わりに PagerDuty Events API v1 を使用します。
`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	必須	このアラート構成トリガーのアラート通知のタイプ。指定できる値は以下のとおりです。 `ADMIN` `GROUP` `USER` `SNMP` 重要 MongoDB Ops Manager 6.0.0 はSNMPアラートを廃止します。 MongoDB Ops Manager 7.0.0 にはSNMPアラートは含まれません。その他のアラートオプションの詳細については、「サードパーティサービスの統合」を参照してください。 `EMAIL` `SMS` （ MongoDB Ops ManagerがTwilio 統合用に構成されている場合にのみ使用できます。） `HIPCHAT` `SLACK` `PAGER_DUTY`
`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	任意	このフィールドは非推奨であり、無視されます。

応答

名前	タイプ	説明
`created`	string	アラート構成が作成されたときの ISO 8601の日付と時刻形式（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	このアラート構成トリガーのアラート通知のタイプ。可能な値は次のとおりです。 `ADMIN` `GROUP` `USER` `SNMP` 重要 MongoDB Ops Manager 6.0.0 はSNMPアラートを廃止します。 MongoDB Ops Manager 7.0.0 にはSNMPアラートは含まれません。その他のアラートオプションの詳細については、「サードパーティサービスの統合」を参照してください。 `EMAIL` `SMS` （ MongoDB Ops ManagerがTwilio 統合用に構成されている場合にのみ使用できます。） `HIPCHAT` `SLACK` `PAGER_DUTY`
`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	このアラート構成が最後に更新されたときの ISO の日付と時刻形式（UTC）のタイムスタンプ。8601

リクエストの例

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --include \
5      --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/globalAlertConfigs \
6      --data '{
7        "enabled": true,
8        "eventTypeName": "BACKUP_AGENT_DOWN",
9        "forAllGroups": true,
10        "groupIds": [],
11        "matchers": [],
12        "notifications": [
13          {
14            "delayMin": 0,
15            "intervalMin": 60,
16            "typeName": "ADMIN"
17          }
18        ],
19        "tags": [],
20        "typeName": "AGENT"
21      }

応答例

応答ヘッダー

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 201 Created
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 }

戻る

1 つの取得

Update

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--include \
5	--request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/globalAlertConfigs \
6	--data '{
7	"enabled": true,
8	"eventTypeName": "BACKUP_AGENT_DOWN",
9	"forAllGroups": true,
10	"groupIds": [],
11	"matchers": [],
12	"notifications": [
13	{
14	"delayMin": 0,
15	"intervalMin": 60,
16	"typeName": "ADMIN"
17	}
18	],
19	"tags": [],
20	"typeName": "AGENT"
21	}

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	}

必須のロール

リクエスト

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

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

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

重要

注意

重要

応答

重要

注意

重要

リクエストの例

応答例

応答ヘッダー

レスポンス本体

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

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

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