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

GET /api/atlas/v2/groups/{groupId}/alertConfigs

1 つのプロジェクトに対するすべてのアラート設定を返します。これらのアラート設定は、プロジェクト内のすべてのコンポーネントに適用されます。アラート設定では、アラートのトリガー条件や通知方法が定義されます。このリソースを使用するには、リクエストを行うサービス アカウントまたは API キーに "プロジェクト読み取り専用" ロールが付与されている必要があります。

このリソースは現在も改訂中であり、変更される可能性があります。

path パラメータ

  • グループ ID string 必須

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

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

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

クエリ パラメータ

  • envelope ブール値

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

    デフォルト値はfalseです。

  • includeCount ブール値

    レスポンスがレスポンス内のアイテムの総数(totalCount)を返すかどうかを示すフラグ。

    デフォルト値はtrueです。

  • itemsPerPage integer

    レスポンスが返す 1 ページあたりのアイテムの数。

    最小値は 1、最大値は 500 です。デフォルト値は 100 です。

  • pageNum integer

    レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号。

    の最小値は 1 です。デフォルト値は 1 です。

  • pretty ブール値

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

    デフォルト値はfalseです。

    Prettyprint

応答

  • 200 application/vnd.atlas.2023-01-01+json

    OK

    応答属性の非表示 応答属性の表示 オブジェクト
    • 結果 array[オブジェクト]

      このリクエストの完了時にMongoDB Cloud が提供する返されたドキュメントのリスト。

      次の 1 つ: