1 つのグローバルアラート構成の有効化または無効化

項目一覧

必須のロール

リクエスト
リクエストパスパラメーター
リクエストクエリパラメータ
リクエストボディパラメータ
応答
リクエストの例
応答例
応答ヘッダー
レスポンス本体

GLOBAL-ALERT-CONFIG-IDによって識別される 1 つのグローバルアラート構成を有効または無効にします。

必須のロール

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

リクエスト

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

PATCH /globalAlertConfigs/{GLOBAL-ALERT-CONFIG-ID}

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

名前	タイプ	必要性	説明
`{GLOBAL-ALERT-CONFIG-ID}`	string	必須	有効または無効にするグローバルアラート構成の一意の識別子。

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

名前

タイプ

必要性

説明

default

pretty

ブール値

任意

レスポンス本体を pretty-print に含めるかどうかを示すフラグ形式。

false

envelope

ブール値

任意

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

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

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

名前	説明
`status`	HTTPレスポンスコード
`content`	期待される応答本体

false

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

Body Parameter	タイプ	必要性	説明
`enabled`	ブール値	必須	グローバルアラート構成が有効か無効かを示すトグル。グローバルアラート構成を有効にするには、 `true`に設定します。グローバルアラート構成を無効にするには、 `false`に設定します。

応答

名前	タイプ	説明
`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.typeName`	string	このアラート構成トリガーのアラート通知のタイプ。可能な値は次のとおりです。 `ADMIN` `GROUP` `USER` `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	ISO8601 のタイムスタンプこのアラート構成が最後に更新されたときの UTC の日付と時刻形式。

リクエストの例

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --include \
5      --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/globalAlertConfigs/{GLOBAL-ALERT-CONFIG-ID}" \
6      --data '{
7        "enabled" : false
8      }'

応答例

応答ヘッダー

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   "created": "2019-10-02T12:34:04Z",
3   "enabled": false,
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 つのグローバルアラート構成の更新

1 つのグローバルアラート構成を削除

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--include \
5	--request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/globalAlertConfigs/{GLOBAL-ALERT-CONFIG-ID}" \
6	--data '{
7	"enabled" : false
8	}'

1	{
2	"created": "2019-10-02T12:34:04Z",
3	"enabled": false,
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	}