1 つのプロジェクトからの 1 つのアラートを確認

PATCH /api/atlas/v2/groups/{groupId}/alerts/{alertId}

既存のアラートを 1 つ受信していることを確認します。このアラートは、1 つのプロジェクト内の任意のコンポーネントに適用されます。アラートを確認すると、通知が連続して行われなくなります。モニター対象コンポーネントが設定した値を満たすか上回ると、アラートを確認するまでアラートが送信されます。このリソースを使用するには、リクエスト元のサービスアカウントまたは API キーに組織オーナーまたはプロジェクトオーナーのロールが必要です。1 つのプロジェクトからすべてのアラートを返すエンドポイントを使用して、認証されたユーザーがアクセス可能なすべてのアラートを取得してください。

このリソースは現在も改訂中であり、変更される可能性があります。非推奨のバージョン: v2-{2023-01-01}

1 つのプロジェクトからすべてのアラートを返す

path パラメータ

グループ ID string 必須

プロジェクトを識別する一意の 24 桁の 16 進数文字列。認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。

注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。
alertId string 必須

アラートを識別するユニークな 24 桁の 16 進数の文字列。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

クエリパラメータ

envelope ブール値

アプリケーションがレスポンスを envelope JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータスパラメータを追加します。

デフォルト値はfalseです。
pretty ブール値

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

デフォルト値はfalseです。

Prettyprint

application/vnd.atlas.2024-05-30+json

body 必須

1 つのアラートを確認または未確認にします。

acknowledgedUntil string(date-time)

このアラートが確認されるまでの日数と時間。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。MongoDB ユーザーが以前にこのアラートを確認済みの場合、リソースはこのパラメータを返します。

ISO 8601
acknowledgementComment string

MongoDB Cloud ユーザーがアラートを確認するときに送信したコメント。

最大長は 200 です。
unacknowledgeAlert ブール値

以前に確認されたアラートを未確認にすることを示すフラグ。この値は、デフォルトで false に設定されています。true に設定されると、acknowledgedUntil パラメータが上書きされます。

応答

200 application/vnd.atlas.2024-05-30+json

OK
次の 1 つ：
AppServiceAlertViewオブジェクト ClusterAlertViewForNdsGroupオブジェクト HostAlertViewForNdsGroupオブジェクト HostMetricAlertオブジェクト ReplicaSetAlertViewForNdsGroupオブジェクト StreamProcessorAlertViewForNdsGroup オブジェクト DefaultAlertViewForNdsGroupオブジェクト
App Servicesアラートは、BASアプリケーションに関するさまざまなアクティビティを通知します。

属性を非表示属性を表示

acknowledgedUntil string(date-time)

このアラートが確認されるまでの日数と時間。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。MongoDB ユーザーが以前にこのアラートを確認済みの場合、リソースはこのパラメータを返します。

このアラートを永久的に確認するには、パラメータ値を 100 年後に設定します。

以前に確認されたアラートを未確認にするには、このパラメータ値を設定しないでください。

ISO 8601

acknowledgementComment string

MongoDB Cloud ユーザーがアラートを確認するときに送信したコメント。

最大長は 200 です。

acknowledgedUsername string(メール)

アラートを確認したユーザーのMongoDB Cloudユーザー名。MongoDB Cloud ユーザーが以前にこのアラートを確認済みの場合、レスポンスはこのパラメータを返します。

alertConfigId string 必須

このアラートを設定するアラート構成を識別する一意の 24 桁の 16 進数文字列。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

作成済み string(date-time) 必須

MongoDB Cloud がこのアラートを作成した日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

ISO 8601

eventTypeName string 必須

このアラートをトリガーしたインシデント。

値は、URL_CONFIRMATION、SUCCESSFUL_DEPLOY、DEPLOYMENT_FAILURE、DEPLOYMENT_MODEL_CHANGE_SUCCESS、DEPLOYMENT_MODEL_CHANGE_FAILURE、REQUEST_RATE_LIMIT、LOG_FORWARDER_FAILURE、OUTSIDE_REALM_METRIC_THRESHOLD、SYNC_FAILURE、TRIGGER_FAILURE、または TRIGGER_AUTO_RESUMED です。

グループ ID string

このアラートを所有するプロジェクトを識別する一意の 24 桁の 16 進数文字列。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

id string 必須

このアラートを識別する一意の 24 桁の 16 進数文字列。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

lastNotified string(date-time)

このアラートの通知が最後に送信された日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。MongoDB Cloud がこのアラートの通知を送信した場合、リソースはこのパラメータを返します。

ISO 8601

Links array[オブジェクト]

APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。

Web リンク仕様（RFC 5988）

リンク属性を非表示にするリンク属性を表示するオブジェクト

href string

この応答が何らかの関係を持つ別のAPIリソースを示す Uniform Resource Locator（ URL ）。このURL は、多くの場合、https://cloud.mongodb.com/api/atlas で始まります。

リリース string

このリソースと別のAPIリソースの間のセマンティック関係を定義する Uniform Resource Locator ( URL ) 。このURL は、多くの場合、https://cloud.mongodb.com/api/atlas で始まります。

orgId string

このアラートが適用されるプロジェクトを所有する組織を識別する一意の 24 文字列。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

解決済み string(date-time)

このアラートが "status" : "CLOSED" に変更された日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。リソースは、"status" : "CLOSED" が 1 回このパラメータを返します。

ISO 8601

状態 string 必須

詳細をリクエストした時点でのこのアラートの状態。 true は、アラート条件が存在するが最小通知遅延時間は保持されていないことを示します。 OPEN は、アラート条件が現在存在していることを示します。 [CLOSED] は、アラート条件が解決されたことを示します。

値は、CANCELLED、CLOSED、OPEN、または TRACKING です。

Updated string(date-time) 必須

このアラートが誰かが最後に更新された日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

ISO 8601
クラスターアラートは、 mongodホストのクラスターに関するさまざまなアクティビティと条件を通知します。

属性を非表示属性を表示

acknowledgedUntil string(date-time)

このアラートが確認されるまでの日数と時間。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。MongoDB ユーザーが以前にこのアラートを確認済みの場合、リソースはこのパラメータを返します。

このアラートを永久的に確認するには、パラメータ値を 100 年後に設定します。

以前に確認されたアラートを未確認にするには、このパラメータ値を設定しないでください。

ISO 8601

acknowledgementComment string

MongoDB Cloud ユーザーがアラートを確認するときに送信したコメント。

最大長は 200 です。

acknowledgedUsername string(メール)

アラートを確認したユーザーのMongoDB Cloudユーザー名。MongoDB Cloud ユーザーが以前にこのアラートを確認済みの場合、レスポンスはこのパラメータを返します。

alertConfigId string 必須

このアラートを設定するアラート構成を識別する一意の 24 桁の 16 進数文字列。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

clusterName string

このアラートが適用されるクラスターを識別する、人間が判読できるラベル。このリソースは、バックアップ、レプリカセット、またはシャーディングされたクラスターに影響を与えるイベントのアラートに対してこのパラメーターを返します。

形式は次のパターンと一致する必要があります: ^[a-zA-Z0-9][a-zA-Z0-9-]*$。

作成済み string(date-time) 必須

MongoDB Cloud がこのアラートを作成した日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

ISO 8601

eventTypeName string 必須

アラートをトリガーするイベントの種類。

値は CLUSTER_MONGOS_IS_MISSING です。

グループ ID string

このアラートを所有するプロジェクトを識別する一意の 24 桁の 16 進数文字列。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

id string 必須

このアラートを識別する一意の 24 桁の 16 進数文字列。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

lastNotified string(date-time)

このアラートの通知が最後に送信された日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。MongoDB Cloud がこのアラートの通知を送信した場合、リソースはこのパラメータを返します。

ISO 8601

Links array[オブジェクト]

APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。

Web リンク仕様（RFC 5988）

リンク属性を非表示にするリンク属性を表示するオブジェクト

href string

この応答が何らかの関係を持つ別のAPIリソースを示す Uniform Resource Locator（ URL ）。このURL は、多くの場合、https://cloud.mongodb.com/api/atlas で始まります。

リリース string

このリソースと別のAPIリソースの間のセマンティック関係を定義する Uniform Resource Locator ( URL ) 。このURL は、多くの場合、https://cloud.mongodb.com/api/atlas で始まります。

orgId string

このアラートが適用されるプロジェクトを所有する組織を識別する一意の 24 文字列。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

解決済み string(date-time)

このアラートが "status" : "CLOSED" に変更された日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。リソースは、"status" : "CLOSED" が 1 回このパラメータを返します。

ISO 8601

状態 string 必須

詳細をリクエストした時点でのこのアラートの状態。 true は、アラート条件が存在するが最小通知遅延時間は保持されていないことを示します。 OPEN は、アラート条件が現在存在していることを示します。 [CLOSED] は、アラート条件が解決されたことを示します。

値は、CANCELLED、CLOSED、OPEN、または TRACKING です。

Updated string(date-time) 必須

このアラートが誰かが最後に更新された日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

ISO 8601
ホストアラートはmongodホスト上のアクティビティを通知します。

属性を非表示属性を表示

acknowledgedUntil string(date-time)

このアラートが確認されるまでの日数と時間。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。MongoDB ユーザーが以前にこのアラートを確認済みの場合、リソースはこのパラメータを返します。

このアラートを永久的に確認するには、パラメータ値を 100 年後に設定します。

以前に確認されたアラートを未確認にするには、このパラメータ値を設定しないでください。

ISO 8601

acknowledgementComment string

MongoDB Cloud ユーザーがアラートを確認するときに送信したコメント。

最大長は 200 です。

acknowledgedUsername string(メール)

アラートを確認したユーザーのMongoDB Cloudユーザー名。MongoDB Cloud ユーザーが以前にこのアラートを確認済みの場合、レスポンスはこのパラメータを返します。

alertConfigId string 必須

このアラートを設定するアラート構成を識別する一意の 24 桁の 16 進数文字列。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

clusterName string

このアラートが適用されるクラスターを識別する、人間が判読できるラベル。このリソースは、バックアップ、レプリカセット、またはシャーディングされたクラスターに影響を与えるイベントのアラートに対してこのパラメーターを返します。

形式は次のパターンと一致する必要があります: ^[a-zA-Z0-9][a-zA-Z0-9-]*$。

作成済み string(date-time) 必須

MongoDB Cloud がこのアラートを作成した日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

ISO 8601

eventTypeName string 必須

アラートをトリガーするイベントの種類。

値は HOST_DOWN、HOST_HAS_INDEX_SUGGESTIONS、HOST_MONGOT_CRASHING_OOM、HOST_MONGOT_STOP_REPLICATION、HOST_MONGOT_APPROACHING_STOP_REPLICATION、HOST_NOT_ENOUGH_DISK_SPACE、SSH_KEY_NDS_HOST_ACCESS_REQUESTED、SSH_KEY_NDS_HOST_ACCESS_REFRESHED、PUSH_BASED_LOG_EXPORT_STOPPED、PUSH_BASED_LOG_EXPORT_DROPPED_LOG、HOST_VERSION_BEHIND、VERSION_BEHIND、 HOST_EXPOSED、HOST_SSL_CERTIFICATE_STALE、または HOST_SECURITY_CHECKUP_NOT_MET 。

グループ ID string

このアラートを所有するプロジェクトを識別する一意の 24 桁の 16 進数文字列。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

ホスト名とポート string

このアラートが適用されるホストのホスト名とポート。リソースは、ホストまたはレプリカセットに影響を与えるイベントのアラートに対してこのパラメーターを返します。

id string 必須

このアラートを識別する一意の 24 桁の 16 進数文字列。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

lastNotified string(date-time)

このアラートの通知が最後に送信された日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。MongoDB Cloud がこのアラートの通知を送信した場合、リソースはこのパラメータを返します。

ISO 8601

Links array[オブジェクト]

APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。

Web リンク仕様（RFC 5988）

リンク属性を非表示にするリンク属性を表示するオブジェクト

href string

この応答が何らかの関係を持つ別のAPIリソースを示す Uniform Resource Locator（ URL ）。このURL は、多くの場合、https://cloud.mongodb.com/api/atlas で始まります。

リリース string

このリソースと別のAPIリソースの間のセマンティック関係を定義する Uniform Resource Locator ( URL ) 。このURL は、多くの場合、https://cloud.mongodb.com/api/atlas で始まります。

orgId string

このアラートが適用されるプロジェクトを所有する組織を識別する一意の 24 文字列。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

ReplicaSetName string

このアラートが適用されるレプリカセットの名前。レスポンスは、バックアップ、ホスト、またはレプリカセットに影響を与えるイベントのアラートに対してこのパラメータを返します。

解決済み string(date-time)

このアラートが "status" : "CLOSED" に変更された日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。リソースは、"status" : "CLOSED" が 1 回このパラメータを返します。

ISO 8601

状態 string 必須

詳細をリクエストした時点でのこのアラートの状態。 true は、アラート条件が存在するが最小通知遅延時間は保持されていないことを示します。 OPEN は、アラート条件が現在存在していることを示します。 [CLOSED] は、アラート条件が解決されたことを示します。

値は、CANCELLED、CLOSED、OPEN、または TRACKING です。

Updated string(date-time) 必須

このアラートが誰かが最後に更新された日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

ISO 8601
ホストメトリクスアラートは、 mongodホストの測定値またはメトリクスの変更を通知します。

属性を非表示属性を表示

acknowledgedUntil string(date-time)

このアラートが確認されるまでの日数と時間。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。MongoDB ユーザーが以前にこのアラートを確認済みの場合、リソースはこのパラメータを返します。

このアラートを永久的に確認するには、パラメータ値を 100 年後に設定します。

以前に確認されたアラートを未確認にするには、このパラメータ値を設定しないでください。

ISO 8601

acknowledgementComment string

MongoDB Cloud ユーザーがアラートを確認するときに送信したコメント。

最大長は 200 です。

acknowledgedUsername string(メール)

アラートを確認したユーザーのMongoDB Cloudユーザー名。MongoDB Cloud ユーザーが以前にこのアラートを確認済みの場合、レスポンスはこのパラメータを返します。

alertConfigId string 必須

このアラートを設定するアラート構成を識別する一意の 24 桁の 16 進数文字列。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

clusterName string

このアラートが適用されるクラスターを識別する、人間が判読できるラベル。このリソースは、バックアップ、レプリカセット、またはシャーディングされたクラスターに影響を与えるイベントのアラートに対してこのパラメーターを返します。

形式は次のパターンと一致する必要があります: ^[a-zA-Z0-9][a-zA-Z0-9-]*$。

作成済み string(date-time) 必須

MongoDB Cloud がこのアラートを作成した日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

ISO 8601

currentValue オブジェクト

アラートをトリガーしたメトリクスの値。リソースは、ホストに影響を与えるイベントのアラートに対してこのパラメータを返します。

currentValue 属性を非表示 currentValue 属性の表示オブジェクト

数値 number(double)

イベントの時に記録された metricName の量。この値によりアラートがトリガーされました。

単位 string

currentValue.number の数量を表すために使用される要素。これは、時間やストレージキャパシティーなどの要素です。このメトリクスはアラートをトリガーしました。

値は bits、Kbits、Mbits、Gbits、bytes、KB、MB、GB、TB、PB、nsec、msec、 sec、min、hours、million minutes、days、requests、1000 requests、GB seconds、GB hours、GB days、RPU、thousand RPU、million RPU、WPU、thousand WPU、million WPU、count、thousand、million、または billion 。

eventTypeName string 必須

アラートをトリガーするイベントの種類。

値は OUTSIDE_METRIC_THRESHOLD です。

グループ ID string

このアラートを所有するプロジェクトを識別する一意の 24 桁の 16 進数文字列。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

ホスト名とポート string

このアラートが適用されるホストのホスト名とポート。リソースは、ホストまたはレプリカセットに影響を与えるイベントのアラートに対してこのパラメーターを返します。

id string 必須

このアラートを識別する一意の 24 桁の 16 進数文字列。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

lastNotified string(date-time)

このアラートの通知が最後に送信された日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。MongoDB Cloud がこのアラートの通知を送信した場合、リソースはこのパラメータを返します。

ISO 8601

Links array[オブジェクト]

APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。

Web リンク仕様（RFC 5988）

リンク属性を非表示にするリンク属性を表示するオブジェクト

href string

この応答が何らかの関係を持つ別のAPIリソースを示す Uniform Resource Locator（ URL ）。このURL は、多くの場合、https://cloud.mongodb.com/api/atlas で始まります。

リリース string

このリソースと別のAPIリソースの間のセマンティック関係を定義する Uniform Resource Locator ( URL ) 。このURL は、多くの場合、https://cloud.mongodb.com/api/atlas で始まります。

metricName string 弁別子

Atlas が構成された metricThreshold.threshold をチェックするメトリクスの名前。

利用可能なメトリクスの詳細については、「ホストメトリクス」を参照してください。

注 : eventTypeName を OUTSIDE_SERVERLESS_METRICS_threshold に設定すると、サーバーレスで使用可能なメトリクスのみを指定できます。詳細については、「サーバーレス測定」を参照してください。

値は HostMetricAlert です。

orgId string

このアラートが適用されるプロジェクトを所有する組織を識別する一意の 24 文字列。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

ReplicaSetName string

このアラートが適用されるレプリカセットの名前。レスポンスは、バックアップ、ホスト、またはレプリカセットに影響を与えるイベントのアラートに対してこのパラメータを返します。

解決済み string(date-time)

このアラートが "status" : "CLOSED" に変更された日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。リソースは、"status" : "CLOSED" が 1 回このパラメータを返します。

ISO 8601

状態 string 必須

詳細をリクエストした時点でのこのアラートの状態。 true は、アラート条件が存在するが最小通知遅延時間は保持されていないことを示します。 OPEN は、アラート条件が現在存在していることを示します。 [CLOSED] は、アラート条件が解決されたことを示します。

値は、CANCELLED、CLOSED、OPEN、または TRACKING です。

Updated string(date-time) 必須

このアラートが誰かが最後に更新された日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

ISO 8601
ReplicaSetアラートは、 mongodインスタンスのレプリカセットでのさまざまなアクティビティについて通知します。

属性を非表示属性を表示

acknowledgedUntil string(date-time)

このアラートが確認されるまでの日数と時間。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。MongoDB ユーザーが以前にこのアラートを確認済みの場合、リソースはこのパラメータを返します。

このアラートを永久的に確認するには、パラメータ値を 100 年後に設定します。

以前に確認されたアラートを未確認にするには、このパラメータ値を設定しないでください。

ISO 8601

acknowledgementComment string

MongoDB Cloud ユーザーがアラートを確認するときに送信したコメント。

最大長は 200 です。

acknowledgedUsername string(メール)

アラートを確認したユーザーのMongoDB Cloudユーザー名。MongoDB Cloud ユーザーが以前にこのアラートを確認済みの場合、レスポンスはこのパラメータを返します。

alertConfigId string 必須

このアラートを設定するアラート構成を識別する一意の 24 桁の 16 進数文字列。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

clusterName string

このアラートが適用されるクラスターを識別する、人間が判読できるラベル。このリソースは、バックアップ、レプリカセット、またはシャーディングされたクラスターに影響を与えるイベントのアラートに対してこのパラメーターを返します。

形式は次のパターンと一致する必要があります: ^[a-zA-Z0-9][a-zA-Z0-9-]*$。

作成済み string(date-time) 必須

MongoDB Cloud がこのアラートを作成した日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

ISO 8601

eventTypeName string 必須

このアラートをトリガーしたインシデント。

値は、REPLICATION_OPLOG_WINDOW_RUNNING_OUT、NO_PRIMARY、PRIMARY_ELECTED、TOO_MANY_ELECTIONS、TOO_FEW_HEALTHY_MEMBERS、または TOO_MANY_UNHEALTHY_MEMBERS です。

グループ ID string

このアラートを所有するプロジェクトを識別する一意の 24 桁の 16 進数文字列。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

ホスト名とポート string

このアラートが適用されるホストのホスト名とポート。リソースは、ホストまたはレプリカセットに影響を与えるイベントのアラートに対してこのパラメーターを返します。

id string 必須

このアラートを識別する一意の 24 桁の 16 進数文字列。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

lastNotified string(date-time)

このアラートの通知が最後に送信された日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。MongoDB Cloud がこのアラートの通知を送信した場合、リソースはこのパラメータを返します。

ISO 8601

Links array[オブジェクト]

APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。

Web リンク仕様（RFC 5988）

リンク属性を非表示にするリンク属性を表示するオブジェクト

href string

この応答が何らかの関係を持つ別のAPIリソースを示す Uniform Resource Locator（ URL ）。このURL は、多くの場合、https://cloud.mongodb.com/api/atlas で始まります。

リリース string

このリソースと別のAPIリソースの間のセマンティック関係を定義する Uniform Resource Locator ( URL ) 。このURL は、多くの場合、https://cloud.mongodb.com/api/atlas で始まります。

nonRuningHostIds array[string]

プライマリ状態でもセカンダリ状態でもないレプリカセットノードを識別する一意の 24 16 進数文字列のリスト。

各の形式は次のパターンと一致する必要があります: ^([a-f0-9]{8,32})$。

orgId string

このアラートが適用されるプロジェクトを所有する組織を識別する一意の 24 文字列。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

parentClusterId string

このアラートが適用される親クラスターを識別する一意の 24 16 進数文字列。親クラスターには、シャーディングされたノードが含まれています。 MongoDB Cloud は、シャーディングされたクラスターに影響を与えるイベントのアラートに対してのみこのパラメーターを返します。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

ReplicaSetName string

このアラートが適用されるレプリカセットの名前。レスポンスは、バックアップ、ホスト、またはレプリカセットに影響を与えるイベントのアラートに対してこのパラメータを返します。

解決済み string(date-time)

このアラートが "status" : "CLOSED" に変更された日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。リソースは、"status" : "CLOSED" が 1 回このパラメータを返します。

ISO 8601

状態 string 必須

詳細をリクエストした時点でのこのアラートの状態。 true は、アラート条件が存在するが最小通知遅延時間は保持されていないことを示します。 OPEN は、アラート条件が現在存在していることを示します。 [CLOSED] は、アラート条件が解決されたことを示します。

値は、CANCELLED、CLOSED、OPEN、または TRACKING です。

Updated string(date-time) 必須

このアラートが誰かが最後に更新された日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

ISO 8601
ストリームプロセッサアラートは、AtlasStreams 内のストリームプロセッサのアクティビティについて通知します。

属性を非表示属性を表示

acknowledgedUntil string(date-time)

このアラートが確認されるまでの日数と時間。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。MongoDB ユーザーが以前にこのアラートを確認済みの場合、リソースはこのパラメータを返します。

このアラートを永久的に確認するには、パラメータ値を 100 年後に設定します。

以前に確認されたアラートを未確認にするには、このパラメータ値を設定しないでください。

ISO 8601

acknowledgementComment string

MongoDB Cloud ユーザーがアラートを確認するときに送信したコメント。

最大長は 200 です。

acknowledgedUsername string(メール)

アラートを確認したユーザーのMongoDB Cloudユーザー名。MongoDB Cloud ユーザーが以前にこのアラートを確認済みの場合、レスポンスはこのパラメータを返します。

alertConfigId string 必須

このアラートを設定するアラート構成を識別する一意の 24 桁の 16 進数文字列。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

作成済み string(date-time) 必須

MongoDB Cloud がこのアラートを作成した日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

ISO 8601

eventTypeName string 必須

アラートをトリガーするイベントの種類。

値は HOST_DOWN、HOST_HAS_INDEX_SUGGESTIONS、HOST_MONGOT_CRASHING_OOM、HOST_MONGOT_STOP_REPLICATION、HOST_MONGOT_APPROACHING_STOP_REPLICATION、HOST_NOT_ENOUGH_DISK_SPACE、SSH_KEY_NDS_HOST_ACCESS_REQUESTED、SSH_KEY_NDS_HOST_ACCESS_REFRESHED、PUSH_BASED_LOG_EXPORT_STOPPED、PUSH_BASED_LOG_EXPORT_DROPPED_LOG、HOST_VERSION_BEHIND、VERSION_BEHIND、 HOST_EXPOSED、HOST_SSL_CERTIFICATE_STALE、または HOST_SECURITY_CHECKUP_NOT_MET 。

グループ ID string

このアラートを所有するプロジェクトを識別する一意の 24 桁の 16 進数文字列。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

id string 必須

このアラートを識別する一意の 24 桁の 16 進数文字列。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

instanceName string

このアラートが適用される Atlas Stream Processing インスタンスの名前。リソースは、Stream Processing インスタンスに影響を与えるイベントのアラートに対してこのパラメーターを返します。

lastNotified string(date-time)

このアラートの通知が最後に送信された日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。MongoDB Cloud がこのアラートの通知を送信した場合、リソースはこのパラメータを返します。

ISO 8601

Links array[オブジェクト]

APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。

Web リンク仕様（RFC 5988）

リンク属性を非表示にするリンク属性を表示するオブジェクト

href string

この応答が何らかの関係を持つ別のAPIリソースを示す Uniform Resource Locator（ URL ）。このURL は、多くの場合、https://cloud.mongodb.com/api/atlas で始まります。

リリース string

このリソースと別のAPIリソースの間のセマンティック関係を定義する Uniform Resource Locator ( URL ) 。このURL は、多くの場合、https://cloud.mongodb.com/api/atlas で始まります。

orgId string

このアラートが適用されるプロジェクトを所有する組織を識別する一意の 24 文字列。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

processorErrorMsg string

このアラートが適用されるストリームプロセッサに関連付けられているエラーメッセージ。

processorName string

このアラートが適用されるストリームプロセッサの名前。リソースは、ストリームプロセッサに影響を与えるイベントのアラートに対してこのパラメーターを返します。

providerState string

このアラートが適用されるストリームプロセッサの状態。リソースは、ストリームプロセッサに影響を与えるイベントのアラートに対してこのパラメーターを返します。

解決済み string(date-time)

このアラートが "status" : "CLOSED" に変更された日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。リソースは、"status" : "CLOSED" が 1 回このパラメータを返します。

ISO 8601

状態 string 必須

詳細をリクエストした時点でのこのアラートの状態。 true は、アラート条件が存在するが最小通知遅延時間は保持されていないことを示します。 OPEN は、アラート条件が現在存在していることを示します。 [CLOSED] は、アラート条件が解決されたことを示します。

値は、CANCELLED、CLOSED、OPEN、または TRACKING です。

Updated string(date-time) 必須

このアラートが誰かが最後に更新された日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

ISO 8601
基本的なアラート以外に追加の詳細がないその他のアラート。

属性を非表示属性を表示

acknowledgedUntil string(date-time)

このアラートが確認されるまでの日数と時間。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。MongoDB ユーザーが以前にこのアラートを確認済みの場合、リソースはこのパラメータを返します。

このアラートを永久的に確認するには、パラメータ値を 100 年後に設定します。

以前に確認されたアラートを未確認にするには、このパラメータ値を設定しないでください。

ISO 8601

acknowledgementComment string

MongoDB Cloud ユーザーがアラートを確認するときに送信したコメント。

最大長は 200 です。

acknowledgedUsername string(メール)

アラートを確認したユーザーのMongoDB Cloudユーザー名。MongoDB Cloud ユーザーが以前にこのアラートを確認済みの場合、レスポンスはこのパラメータを返します。

alertConfigId string 必須

このアラートを設定するアラート構成を識別する一意の 24 桁の 16 進数文字列。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

作成済み string(date-time) 必須

MongoDB Cloud がこのアラートを作成した日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

ISO 8601

eventTypeName string 必須

このアラートをトリガーしたインシデント。

次の 1 つ：
請求イベントタイプ string Cps バックアップイベントタイプ string 暗号化イベントタイプ string FTS インデックス監査タイプ string グループイベントタイプ string NDS監査タイプ string NDS メンテナンスウィンドウ監査タイプ string NDS x509 ユーザー認証イベントタイプ string Atlas Online アーカイブイベントタイプ string サーバーレスイベントタイプ string フレキシブルなメトリクスイベントタイプ string ユーザーイベントタイプ string リソースイベントタイプ string ストリームプロセッサのイベントタイプ string NDS オートスケーリング監査タイプ string データ保護イベントの種類 string Atlas リソースポリシー監査タイプ string

値は CREDIT_CARD_ABOUT_TO_EXPIRE、PENDING_INVOICE_OVER_THRESHOLD、または DAILY_BILL_OVER_THRESHOLD です。

値は CPS_SNAPSHOT_STARTED、CPS_SNAPSHOT_SUCCESSFUL、CPS_SNAPSHOT_FAILED、CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY、CPS_SNAPSHOT_BEHIND、CPS_COPY_SNAPSHOT_STARTED、CPS_COPY_SNAPSHOT_FAILED、CPS_COPY_SNAPSHOT_FAILED_WILL_RETRY、CPS_COPY_SNAPSHOT_SUCCESSFUL、CPS_PREV_SNAPSHOT_OLD、CPS_SNAPSHOT_FALLBACK_SUCCESSFUL、CPS_SNAPSHOT_FALLBACK_FAILED、 CPS_RESTORE_SUCCESSFUL、CPS_EXPORT_SUCCESSFUL、CPS_RESTORE_FAILED、CPS_EXPORT_FAILED、CPS_AUTO_EXPORT_FAILED、CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED、CPS_OPLOG_BEHIND、または CPS_OPLOG_CAUGHT_UP

値は、AWS_ENCRYPTION_KEY_NEEDS_ROTATION、AZURE_ENCRYPTION_KEY_NEEDS_ROTATION、GCP_ENCRYPTION_KEY_NEEDS_ROTATION、AWS_ENCRYPTION_KEY_INVALID、AZURE_ENCRYPTION_KEY_INVALID、または GCP_ENCRYPTION_KEY_INVALID です。

値は、FTS_INDEX_DELETION_FAILED、FTS_INDEX_BUILD_COMPLETE、FTS_INDEX_BUILD_FAILED、FTS_INDEXES_RESTORE_FAILED、または FTS_INDEXES_SYNONYM_MAPPING_INVALID です。

値は、USERS_WITHOUT_MULTI_FACTOR_AUTH、ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED、ENCRYPTION_AT_REST_CONFIG_NO_LONGER_VALID、GROUP_SERVICE_ACCOUNT_SECRETS_EXPIRING、または GROUP_SERVICE_ACCOUNT_SECRETS_EXPIRED です。

値は、CLUSTER_INSTANCE_STOP_START、CLUSTER_INSTANCE_RESYNC_REQUESTED、CLUSTER_INSTANCE_UPDATE_REQUESTED、SAMPLE_DATASET_LOAD_REQUESTED、TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL、TENANT_UPGRADE_TO_SERVERLESS_FAILED、NETWORK_PERMISSION_ENTRY_ADDED、NETWORK_PERMISSION_ENTRY_REMOVED、NETWORK_PERMISSION_ENTRY_UPDATED、CLUSTER_BLOCK_WRITE、または CLUSTER_UNBLOCK_WRITE です。

値は、MAINTENANCE_IN_ADVANCED、MAINTENANCE_AUTO_DEFERRED、MAINTENANCE_STARTED、または MAINTENANCE_NO_LONGER_NEEDED です。

値は NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK、NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK、または NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK です。

値は ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK または ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK です。

値は OUTSIDE_SERVERLESS_METRIC_THRESHOLD です。

値は OUTSIDE_FLEX_METRIC_THRESHOLD です。

値は JOINED_GROUP、REMOVED_FROM_GROUP、または USER_ROLES_CHANGED_AUDIT です。

値は TAGS_MODIFIED、CLUSTER_TAGS_MODIFIED、または GROUP_TAGS_MODIFIED です。

値は STREAM_PROCESSOR_STATE_IS_FAILED または OUTSIDE_STREAM_PROCESSOR_METRIC_THRESHOLD です。

値は COMPUTE_AUTO_SCALE_INITIATED_BASE、COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS、COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE、COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS、COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE、COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS、COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE、COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS、DISK_AUTO_SCALE_INITIATED、DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL、DISK_AUTO_SCALE_OPLOG_FAIL、PREDICTIVE_COMPUTE_AUTO_SCALE_INITIATED_BASE、 PREDICTIVE_COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE、または PREDICTIVE_COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE

値は、CPS_DATA_PROTECTION_ENABLE_REQUESTED、CPS_DATA_PROTECTION_ENABLED、CPS_DATA_PROTECTION_UPDATE_REQUESTED、CPS_DATA_PROTECTION_UPDATED、CPS_DATA_PROTECTION_DISABLE_REQUESTED、CPS_DATA_PROTECTION_DISABLED、または CPS_DATA_PROTECTION_APPROVED_FOR_DISABLEMENT です。

値は RESOURCE_POLICY_VIOLATED です。

グループ ID string

このアラートを所有するプロジェクトを識別する一意の 24 桁の 16 進数文字列。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

id string 必須

このアラートを識別する一意の 24 桁の 16 進数文字列。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

lastNotified string(date-time)

このアラートの通知が最後に送信された日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。MongoDB Cloud がこのアラートの通知を送信した場合、リソースはこのパラメータを返します。

ISO 8601

Links array[オブジェクト]

APIサブリソース、関連APIリソース、またはその両方を点する 1 つ以上の Uniform Resource Locator（URL）のリスト。 RFC 5988 はこれらの関係の概要をまとめています。

Web リンク仕様（RFC 5988）

リンク属性を非表示にするリンク属性を表示するオブジェクト

href string

この応答が何らかの関係を持つ別のAPIリソースを示す Uniform Resource Locator（ URL ）。このURL は、多くの場合、https://cloud.mongodb.com/api/atlas で始まります。

リリース string

このリソースと別のAPIリソースの間のセマンティック関係を定義する Uniform Resource Locator ( URL ) 。このURL は、多くの場合、https://cloud.mongodb.com/api/atlas で始まります。

orgId string

このアラートが適用されるプロジェクトを所有する組織を識別する一意の 24 文字列。

形式は次のパターンと一致する必要があります: ^([a-f0-9]{24})$。

解決済み string(date-time)

このアラートが "status" : "CLOSED" に変更された日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。リソースは、"status" : "CLOSED" が 1 回このパラメータを返します。

ISO 8601

状態 string 必須

詳細をリクエストした時点でのこのアラートの状態。 true は、アラート条件が存在するが最小通知遅延時間は保持されていないことを示します。 OPEN は、アラート条件が現在存在していることを示します。 [CLOSED] は、アラート条件が解決されたことを示します。

値は、CANCELLED、CLOSED、OPEN、または TRACKING です。

Updated string(date-time) 必須

このアラートが誰かが最後に更新された日時。このパラメータは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

ISO 8601
400 application/ JSON

無効なリクエストです。
応答属性の非表示応答属性の表示オブジェクト
- validRequestDetail オブジェクト
  
  無効なリクエストの詳細。
  
  validRequestDetail 属性を非表示にする validRequestDetail 属性の表示オブジェクト
  
  フィールド array[オブジェクト]
  
  クライアントリクエストにおけるすべての違反を説明します。
  
  フィールド属性を非表示にするフィールド属性の表示オブジェクト
  
  説明 string 必須
  
  リクエスト要素が禁止されている理由の説明。
  
  フィールド string 必須
  
  リクエスト本文内のフィールドにつながるパス。
- 詳細 string
  
  各タイプのエラーの原因となる特定の条件または理由について説明します。
- エラー integer(int32) 必須
  
  このエラーで返された HTTP ステータスコード。
  
  外部ドキュメント
- errorCode string 必須
  
  このエラーで返されたアプリケーションエラーコード。
- パラメーター array[オブジェクト]
  
  エラーに関する詳細情報を提供するために使用されるパラメーター。
- 理由 string
  
  このエラーで返されたアプリケーションエラーメッセージ。
401 application/ JSON

許可されていません。
応答属性の非表示応答属性の表示オブジェクト
- validRequestDetail オブジェクト
  
  無効なリクエストの詳細。
  
  validRequestDetail 属性を非表示にする validRequestDetail 属性の表示オブジェクト
  
  フィールド array[オブジェクト]
  
  クライアントリクエストにおけるすべての違反を説明します。
  
  フィールド属性を非表示にするフィールド属性の表示オブジェクト
  
  説明 string 必須
  
  リクエスト要素が禁止されている理由の説明。
  
  フィールド string 必須
  
  リクエスト本文内のフィールドにつながるパス。
- 詳細 string
  
  各タイプのエラーの原因となる特定の条件または理由について説明します。
- エラー integer(int32) 必須
  
  このエラーで返された HTTP ステータスコード。
  
  外部ドキュメント
- errorCode string 必須
  
  このエラーで返されたアプリケーションエラーコード。
- パラメーター array[オブジェクト]
  
  エラーに関する詳細情報を提供するために使用されるパラメーター。
- 理由 string
  
  このエラーで返されたアプリケーションエラーメッセージ。
403 application/ JSON

Forbidden.
応答属性の非表示応答属性の表示オブジェクト
- validRequestDetail オブジェクト
  
  無効なリクエストの詳細。
  
  validRequestDetail 属性を非表示にする validRequestDetail 属性の表示オブジェクト
  
  フィールド array[オブジェクト]
  
  クライアントリクエストにおけるすべての違反を説明します。
  
  フィールド属性を非表示にするフィールド属性の表示オブジェクト
  
  説明 string 必須
  
  リクエスト要素が禁止されている理由の説明。
  
  フィールド string 必須
  
  リクエスト本文内のフィールドにつながるパス。
- 詳細 string
  
  各タイプのエラーの原因となる特定の条件または理由について説明します。
- エラー integer(int32) 必須
  
  このエラーで返された HTTP ステータスコード。
  
  外部ドキュメント
- errorCode string 必須
  
  このエラーで返されたアプリケーションエラーコード。
- パラメーター array[オブジェクト]
  
  エラーに関する詳細情報を提供するために使用されるパラメーター。
- 理由 string
  
  このエラーで返されたアプリケーションエラーメッセージ。
404 application/ JSON

見つかりません。
応答属性の非表示応答属性の表示オブジェクト
- validRequestDetail オブジェクト
  
  無効なリクエストの詳細。
  
  validRequestDetail 属性を非表示にする validRequestDetail 属性の表示オブジェクト
  
  フィールド array[オブジェクト]
  
  クライアントリクエストにおけるすべての違反を説明します。
  
  フィールド属性を非表示にするフィールド属性の表示オブジェクト
  
  説明 string 必須
  
  リクエスト要素が禁止されている理由の説明。
  
  フィールド string 必須
  
  リクエスト本文内のフィールドにつながるパス。
- 詳細 string
  
  各タイプのエラーの原因となる特定の条件または理由について説明します。
- エラー integer(int32) 必須
  
  このエラーで返された HTTP ステータスコード。
  
  外部ドキュメント
- errorCode string 必須
  
  このエラーで返されたアプリケーションエラーコード。
- パラメーター array[オブジェクト]
  
  エラーに関する詳細情報を提供するために使用されるパラメーター。
- 理由 string
  
  このエラーで返されたアプリケーションエラーメッセージ。
500 application/ JSON

内部サーバーエラー。
応答属性の非表示応答属性の表示オブジェクト
- validRequestDetail オブジェクト
  
  無効なリクエストの詳細。
  
  validRequestDetail 属性を非表示にする validRequestDetail 属性の表示オブジェクト
  
  フィールド array[オブジェクト]
  
  クライアントリクエストにおけるすべての違反を説明します。
  
  フィールド属性を非表示にするフィールド属性の表示オブジェクト
  
  説明 string 必須
  
  リクエスト要素が禁止されている理由の説明。
  
  フィールド string 必須
  
  リクエスト本文内のフィールドにつながるパス。
- 詳細 string
  
  各タイプのエラーの原因となる特定の条件または理由について説明します。
- エラー integer(int32) 必須
  
  このエラーで返された HTTP ステータスコード。
  
  外部ドキュメント
- errorCode string 必須
  
  このエラーで返されたアプリケーションエラーコード。
- パラメーター array[オブジェクト]
  
  エラーに関する詳細情報を提供するために使用されるパラメーター。
- 理由 string
  
  このエラーで返されたアプリケーションエラーメッセージ。

PATCH /api/atlas/v2 /groups/{groupId}/alerts/{alertId}

atlas api alerts acknowledgeGroupAlert --help

import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20241023001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.AcknowledgeGroupAlertApiParams{}
	sdkResp, httpResp, err := client.AlertsApi.
		AcknowledgeGroupAlertWithParams(ctx, params).
		Execute()
}

curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2024-10-23+json" \
  --header "Content-Type: application/json" \
  -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}" \
  -d '{ <Payload> }'

curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2024-10-23+json" \
  --header "Content-Type: application/json" \
  -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/alerts/{alertId}" \
  -d '{ <Payload> }'

リクエスト例

{
  "acknowledgedUntil": "2025-05-04T09:42:00Z",
  "acknowledgementComment": "Expiration on 3/19.  Silencing for 7days.",
  "unacknowledgeAlert": true
}

応答の例（200）

{
  "acknowledgedUntil": "2025-05-04T09:42:00Z",
  "acknowledgementComment": "Expiration on 3/19.  Silencing for 7days.",
  "acknowledgingUsername": "hello@example.com",
  "alertConfigId": "32b6e34b3d91647abb20e7b8",
  "created": "2025-05-04T09:42:00Z",
  "eventTypeName": "DEPLOYMENT_FAILURE",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "lastNotified": "2025-05-04T09:42:00Z",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "resolved": "2025-05-04T09:42:00Z",
  "status": "OPEN",
  "updated": "2025-05-04T09:42:00Z"
}

{
  "acknowledgedUntil": "2025-05-04T09:42:00Z",
  "acknowledgementComment": "Expiration on 3/19.  Silencing for 7days.",
  "acknowledgingUsername": "hello@example.com",
  "alertConfigId": "32b6e34b3d91647abb20e7b8",
  "clusterName": "cluster1",
  "created": "2025-05-04T09:42:00Z",
  "eventTypeName": "CLUSTER_MONGOS_IS_MISSING",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "lastNotified": "2025-05-04T09:42:00Z",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "resolved": "2025-05-04T09:42:00Z",
  "status": "OPEN",
  "updated": "2025-05-04T09:42:00Z"
}

{
  "acknowledgedUntil": "2025-05-04T09:42:00Z",
  "acknowledgementComment": "Expiration on 3/19.  Silencing for 7days.",
  "acknowledgingUsername": "hello@example.com",
  "alertConfigId": "32b6e34b3d91647abb20e7b8",
  "clusterName": "cluster1",
  "created": "2025-05-04T09:42:00Z",
  "eventTypeName": "HOST_DOWN",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "hostnameAndPort": "cloud-test.mongodb.com:27017",
  "id": "32b6e34b3d91647abb20e7b8",
  "lastNotified": "2025-05-04T09:42:00Z",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "replicaSetName": "event-replica-set",
  "resolved": "2025-05-04T09:42:00Z",
  "status": "OPEN",
  "updated": "2025-05-04T09:42:00Z"
}

{
  "acknowledgedUntil": "2025-05-04T09:42:00Z",
  "acknowledgementComment": "Expiration on 3/19.  Silencing for 7days.",
  "acknowledgingUsername": "hello@example.com",
  "alertConfigId": "32b6e34b3d91647abb20e7b8",
  "clusterName": "cluster1",
  "created": "2025-05-04T09:42:00Z",
  "currentValue": {
    "number": 42.0,
    "units": "bits"
  },
  "eventTypeName": "OUTSIDE_METRIC_THRESHOLD",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "hostnameAndPort": "cloud-test.mongodb.com:27017",
  "id": "32b6e34b3d91647abb20e7b8",
  "lastNotified": "2025-05-04T09:42:00Z",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "metricName": "ASSERT_USER",
  "orgId": "32b6e34b3d91647abb20e7b8",
  "replicaSetName": "event-replica-set",
  "resolved": "2025-05-04T09:42:00Z",
  "status": "OPEN",
  "updated": "2025-05-04T09:42:00Z"
}

{
  "acknowledgedUntil": "2025-05-04T09:42:00Z",
  "acknowledgementComment": "Expiration on 3/19.  Silencing for 7days.",
  "acknowledgingUsername": "hello@example.com",
  "alertConfigId": "32b6e34b3d91647abb20e7b8",
  "clusterName": "cluster1",
  "created": "2025-05-04T09:42:00Z",
  "eventTypeName": "NO_PRIMARY",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "hostnameAndPort": "cloud-test.mongodb.com:27017",
  "id": "32b6e34b3d91647abb20e7b8",
  "lastNotified": "2025-05-04T09:42:00Z",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "nonRunningHostIds": [
    "32b6e34b3d91647abb20e7b8"
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "parentClusterId": "32b6e34b3d91647abb20e7b8",
  "replicaSetName": "event-replica-set",
  "resolved": "2025-05-04T09:42:00Z",
  "status": "OPEN",
  "updated": "2025-05-04T09:42:00Z"
}

{
  "acknowledgedUntil": "2025-05-04T09:42:00Z",
  "acknowledgementComment": "Expiration on 3/19.  Silencing for 7days.",
  "acknowledgingUsername": "hello@example.com",
  "alertConfigId": "32b6e34b3d91647abb20e7b8",
  "created": "2025-05-04T09:42:00Z",
  "eventTypeName": "HOST_DOWN",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "instanceName": "foobar",
  "lastNotified": "2025-05-04T09:42:00Z",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "processorErrorMsg": "MongoServerError: Failed to start stream processor: (Location77175) Could not connect to the Kafka topic with kafka error code: -195, message: Local: Broker transport failure.: (Location77175)",
  "processorName": "foobar",
  "processorState": "STARTED",
  "resolved": "2025-05-04T09:42:00Z",
  "status": "OPEN",
  "updated": "2025-05-04T09:42:00Z"
}

{
  "acknowledgedUntil": "2025-05-04T09:42:00Z",
  "acknowledgementComment": "Expiration on 3/19.  Silencing for 7days.",
  "acknowledgingUsername": "hello@example.com",
  "alertConfigId": "32b6e34b3d91647abb20e7b8",
  "created": "2025-05-04T09:42:00Z",
  "eventTypeName": "CREDIT_CARD_ABOUT_TO_EXPIRE",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "lastNotified": "2025-05-04T09:42:00Z",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "orgId": "32b6e34b3d91647abb20e7b8",
  "resolved": "2025-05-04T09:42:00Z",
  "status": "OPEN",
  "updated": "2025-05-04T09:42:00Z"
}

応答の例（400）

{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}

応答の例（401）

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

応答の例（403）

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

応答の例（404）

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

応答の例（500）

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}