1 つのプロジェクトのすべてのクラスターを返す

GET /api/atlas/v2/groups/{groupId}/clusters
サービス アカウント DigestAuth

アクセス可能な特定のプロジェクトのすべてのクラスターの詳細を返します。クラスターには、同じデータセットを維持するホストのグループが含まれます。レスポンスには、非対称サイズのシャードがあるクラスターが含まれます。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクトの読み取り専用ロールが必要です。この機能はサーバーレス クラスターでは利用できません。

このエンドポイントは、 createCluster エンドポイントを使用して作成された Flex クラスター、または2 51 月 5 日まで Flex クラスターに移行された以前の M /M2026 クラスターでも使用できます。代わりに、Flex クラスターには listFlexClusters エンドポイントを使用してください。非推奨バージョン: v2-{2023-02-01}、v2-{2023-01-01}

listFlexClusters

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
  • includeDeletedWithRetainedBackups ブール値

    バックアップを保持するクラスターを返すかどうかを示すフラグ。

    デフォルト値はfalseです。

応答

  • 200 application/vnd.atlas.2024-08-05+json

    OK

    応答属性の非表示 応答属性の表示 オブジェクト
    • 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 で始まります。

    • 結果 array[オブジェクト]

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

      結果属性を非表示にする 結果属性の表示 オブジェクト
      • acceptDataRisksAndForceReplicaSetReconfig string(date-time)

        リージョン停止によりプライマリを復旧するために再構成が必要な場合は、トポロジーの再構成と一緒にこのフィールドを送信して、新たなリージョン停止に耐性のあるトポロジーをリクエストしてください。複製された書込み（過半数がコミットされた書込みであっても）が新しいプライマリ ノードに複製されていない場合、選挙可能なノードの大部分が停止している間に強制再構成を行うと、データが失われるリスクがあります。MongoDB Atlas のドキュメントに詳しい情報が記載されています。このリスクを伴う操作を続行するには、acceptDataRisksAndForceReplicaSetReconfig を現在の日付に設定してください。 このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

        リージョン停止時のレプリカセットの再構成
      • 高度な構成 オブジェクト

        高度な構成の詳細のサブセットを構成する設定のグループ。

        advancedConfiguration 属性を非表示にする advancedConfiguration 属性の表示 オブジェクト
        • customOpensslCisphereConfigTls12 array[string]

          TLS 1.2 のカスタム OpenSSL 暗号スイート リスト。 このフィールドは、tlsCipherConfigMode が CUSTOM に設定されている場合にのみ有効です。

          値は TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 または TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 です。

        • minimumEnabledTlsProtocol string

          クラスターが受信接続に受け入れる TLS（Transport Layer Security）の最小バージョン。TLS 1.0 または 1.1 を使用するクラスターでは、TLS プロトコルの最小バージョンとして TLS 1.2 を設定することを検討する必要があります。

          値は TLS1_0、TLS1_1、または TLS1_2 です。

          このオプションは、`netsldisabledProtocols` `mongod`構成ファイルオプションに相当します
        • tlsCisphereConfigMode string

          TLS 暗号スイートの 構成モード。 デフォルトモードでは、デフォルトの暗号スイートが使用されます。 カスタムモードでは、 TLS 1.2 と TLS 1.3 の両方のカスタム暗号スイートを指定できます。

          値は CUSTOM または DEFAULT です。

      • backupEnabled ブール値

        クラスターがバックアップを実行できるかどうかを示すフラグ。true に設定されている場合、クラスターはバックアップを実行できます。true NVMe クラスターの場合、この値を に設定する必要があります。バックアップは、専有クラスターには クラウドバックアップ を使用し、テナント クラスターには 共有クラスター バックアップ を使用します。false に設定されている場合は、クラスターはバックアップを使用しません。

        デフォルト値はfalseです。

        クラウドバックアップ
      • BI Connector オブジェクト

        このクラスターの MongoDB Connector for Business Intelligence を構成するために必要な設定。

        MongoDB Connector for Business Intelligence
        bioConnector 属性を非表示にする bioConnector 属性の表示 オブジェクト
        • enabled ブール値

          MongoDB Connector for Business Intelligence が指定されたクラスターで有効になっているかどうかを示すフラグ。

        • readPreference string

          MongoDB Cloud 上のMongoDB Connector for Business Intelligence に指定されたデータソースノード。 MongoDB Cloud 上のMongoDB Connector for Business Intelligence は、 読み込み設定（read preference） に基づいて、プライマリ、セカンダリ、または分析ノードからデータを読み取ります。デフォルトは ANALYTICSノード、または ANALYTICS ノードがない場合は SECONDARY になります。

          値は PRIMARY、SECONDARY、または ANALYTICS です。

          BI Connector の 読み込み設定 (read preference)
      • clusterType string

        クラスターを構成するノードの構成。

        値は REPLICASET、SHARDED、または GEOSHARDED です。

      • configServerManagementMode string

        シャーディングされたクラスターを作成または更新するためのコンフィギュレーションサーバー マネジメント モード。

        ATLAS_MANAGED として構成されている場合、Atlas は最適なパフォーマンスとコスト削減のために、クラスターのコンフィギュレーションサーバーの種類を自動的に切り替える場合があります。

        FIXED_TO_DEDICATED として構成すると、クラスターは常に専用のコンフィギュレーションサーバーを使用します。

        値は ATLAS_MANAGED または FIXED_TO_DEDICATED です。デフォルト値は ATLAS_MANAGED です。

        MongoDB シャーディングされたクラスターのコンフィギュレーション サーバー
      • configServerType string

        シャーディングされたクラスターのコンフィギュレーションサーバーのタイプを説明します。

        値は DEDICATED または EMBEDDED です。

        MongoDB シャーディングされたクラスターのコンフィギュレーション サーバー
      • 接続文字列 オブジェクト

        MongoDB データベースを指すユニフォーム リソース ロケータのコレクション。

        接続文字列 URI形式
        connectionStrings 属性を非表示にする connectionStrings 属性の表示 オブジェクト
        • awsPrivateLink オブジェクト

          Amazon Web Services （AWS ） PrivateLink でホストされるAWSホスト型クラスターを使用する、プライベートエンドポイント対応の接続文字列。各キーはAmazon Web Services （AWS）のインターフェイスエンドポイントを識別します。各値は、キーが名前を付けるインターフェイスエンドポイントを介してMongoDB Cloud に接続するために使用する関連する mongodb://接続文字列を識別します。

          ネットワークピアリング接続
          awsPrivateLink 属性を非表示にする awsPrivateLink 属性を表示 オブジェクト
          • * string additionalProperties

            Amazon Web Services （AWS ） PrivateLink でホストされるAWSホスト型クラスターを使用する、プライベートエンドポイント対応の接続文字列。各キーはAmazon Web Services （AWS）のインターフェイスエンドポイントを識別します。各値は、キーが名前を付けるインターフェイスエンドポイントを介してMongoDB Cloud に接続するために使用する関連する mongodb://接続文字列を識別します。

            ネットワークピアリング接続
        • awsPrivateLinkSrv オブジェクト

          Amazon Web Services （AWS ） PrivateLink でホストされるAWSホスト型クラスターを使用する、プライベートエンドポイント対応の接続文字列。各キーはAmazon Web Services （AWS）のインターフェイスエンドポイントを識別します。各値は、キーが名前を付けるインターフェイスエンドポイントを介してmongodb:// Atlas に接続するために使用する関連する 接続文字列を識別します。クラスターがawsPrivateLinkSrv 最適化された接続文字列を使用する場合、awsPrivateLinkSrv には最適化された接続文字列が含まれます。クラスターに最適化されていない（レガシー）接続文字列がある場合、最適化された接続文字列が含まれます。

          ネットワークピアリング接続
          awsPrivateLinkSrv 属性を非表示にする awsPrivateLinkSrv 属性を表示 オブジェクト
          • * string additionalProperties

            Amazon Web Services （AWS ） PrivateLink でホストされるAWSホスト型クラスターを使用する、プライベートエンドポイント対応の接続文字列。各キーはAmazon Web Services （AWS）のインターフェイスエンドポイントを識別します。各値は、キーが名前を付けるインターフェイスエンドポイントを介してmongodb:// Atlas に接続するために使用する関連する 接続文字列を識別します。クラスターがawsPrivateLinkSrv 最適化された接続文字列を使用する場合、awsPrivateLinkSrv には最適化された接続文字列が含まれます。クラスターに最適化されていない（レガシー）接続文字列がある場合、最適化された接続文字列が含まれます。

            ネットワークピアリング接続
        • private string

          このクラスターに接続するために構成した各インターフェースの仮想プライベートクラウド（VPC）エンドポイントのネットワークピアリング接続文字列。この接続文字列はmongodb+srv://プロトコルを使用します。リソースは、このクラスターへのネットワークピアリング接続がユーザーが作成すると、このパラメーターを返します。このプロトコルは、アプリケーションにDNS（Domain Name System）でホストシードリストを検索するように指示します。このリストは、クラスター内のノードと同期します。接続文字列がこの URI（Uniform Resource Identifier）形式を使用している場合、ノードが変更された場合にシードリストを追加したり、URI を変更したりする必要はありません。ドライバーが URI 形式をサポートしている場合は、この URI形式を使用します 。そうでない場合は、 connectionStrings.private を使用します。 Amazon Web Services （AWS）クラスターの場合、このリソースはカスタム DNS を有効にしている場合にのみこのパラメーターを返します。

          ネットワークピアリング接続
        • privateEndpoint array[オブジェクト]

          プライベートエンドポイント経由でこのクラスターに接続するために使用できるプライベートエンドポイント対応接続文字列のリスト。このパラメーターは、このクラスターのノードを配置したすべてのリージョンにプライベートエンドポイントを配置した場合にのみ を返します。

          プライベートエンドポイントを認識する接続文字列。プライベートエンドポイントを介してこのクラスターに接続するために使用できます。

          privateEndpoint 属性を非表示 privateEndpoint 属性の表示 オブジェクト
          • ConnectionString string

            プライベートエンドポイントを認識する接続文字列。mongodb://プロトコルを使用し、プライベートエンドポイントを介してMongoDB Cloud に接続します。

          • エンドポイント array[オブジェクト]

            connectionStrings.privateEndpoint[n]. connectionString または connectionStrings.privateEndpoint[n].srvConnectionString を使用するときにMongoDB Cloud に接続するプライベートエンドポイントを含むリスト。

            このクラスターに配置されたプライベートエンドポイントの詳細。

            エンドポイント属性の非表示 エンドポイント属性の表示 オブジェクト
            • endpointId string

              クラウドプロバイダーがプライベートエンドポイントを識別するために使用する一意の string。

            • providerName string

              MongoDB Cloud がプライベートエンドポイントを配置するクラウドプロバイダー。

              値は AWS、AZURE、または GCP です。

            • リージョン string

              プライベートエンドポイントが配置されるリージョン。

          • srvConnectionString string

            プライベートエンドポイントを認識する接続文字列。mongodb+srv://プロトコルを使用し、プライベートエンドポイントを介してMongoDB Cloud に接続します。 mongodb+srvプロトコルは、Domain Name System（DNS）内のホストのシードリストを検索するようにドライバーに指示します。このリストは、クラスター内のノードと同期します。接続文字列がこの URI（Uniform Resource Identifier）形式を使用している場合、ノードが変更された場合にシードリストを追加したり、Uniform Resource Identifier（URI）を変更したりする必要はありません。アプリケーションがURI（Uniform Resource Identifier）をサポートしている場合は、この URI（Uniform Resource Identifier）形式を使用します 。そうでない場合は、 connectionStrings.privateEndpoint[n]. connectionString を使用します。

          • srvShardOptimizedConnectionString string

            シャーディングされたクラスター用に最適化されたプライベートエンドポイント対応の接続文字列。mongodb+srv://プロトコルを使用してプライベートエンドポイント経由でMongoDB Cloud に接続します。接続文字列がこの URI（Uniform Resource Identifier）形式を使用している場合、ノードが変更された場合に URI（Uniform Resource Identifier）を変更する必要はありません。アプリケーションと Atlas クラスターが URI（Uniform Resource Identifier）をサポートしている場合は、この URI（Uniform Resource Identifier）形式を使用します 。含まれない場合は、 connectionStrings.privateEndpoint[n].srvConnectionString を使用してドキュメントを参照してください。

          • タイプ string

            アプリケーションが接続するMongoDBプロセス タイプ。レプリカセットには MONGOD を使用し、シャーディングされたクラスターには MONGOS を使用します。

            値は MONGOD または MONGOS です。

        • privateSrv string

          このクラスターに接続するために構成した各インターフェースの仮想プライベートクラウド（VPC）エンドポイントのネットワークピアリング接続文字列。この接続文字列はmongodb+srv:// プロトコルを使用します。リソースは、このクラスターへのネットワークピアリング接続が誰かが作成したときに、このパラメータを返します。このプロトコルは、アプリケーションにDNS（Domain Name System）でホストシードリストを検索するように指示します。このリストは、クラスター内のノードと同期します。接続文字列がこの URI（Uniform Resource Identifier）形式を使用している場合、ノードが変更された場合にシードリストを追加したり、Uniform Resource Identifier（URI）を変更したりする必要はありません。ドライバーが URI（Uniform Resource Identifier） をサポートしている場合は、この URI（Uniform Resource Identifier）形式を使用します。問題が発生しない場合は、connectionStrings.private を使用します。 Amazon Web Services （AWS）クラスターの場合、このパラメーターはカスタム DNS を有効にしている場合にのみ返します。

          ネットワークピアリング接続
        • 標準 string

          このクラスターに接続するために使用できるパブリック接続文字列。この接続文字列はmongodb://プロトコルを使用します。

          接続文字列 URI 形式
        • standardSrv string

          このクラスターに接続するために使用できるパブリック接続文字列。この接続文字列はmongodb+srv://プロトコルを使用します。

          接続文字列 URI 形式
      • createDate string(date-time)

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

      • diskWarmingMode string

        ディスク ウォーミング モードの選択。

        値は FULLY_WARMED または VISIBLE_EARLIER です。デフォルト値は FULLY_WARMED です。

        セカンダリ ディスク ウォーミングの影響軽減
      • encryptionAtRestProvider string

        カスタマー キーを管理して、クラスターの保管時の暗号化の追加レイヤーを提供するクラウド サービス プロバイダー。保管時の暗号化のためのカスタマー キー管理を有効にするには、クラスター eplicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize の設定は、M10 以上、かつ "backupEnabled" : false または完全に省略する必要があります。

        値は、NONE、AWS、AZURE、または GCP です。

        カスタマー キー管理を使用した保管時の暗号化
      • 機能の互換性バージョン string

        クラスターの機能の互換性バージョン。これは、FCV が固定されているかどうかに関係なく、常に表示されます。

      • featureCompatibilityVersionExpirationDate string(date-time)

        機能の互換性バージョンの有効期限日。FCV がピン留めされている場合にのみ表示されます。 このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

      • globalClusterSelfManagedSharding ブール値

        新しいグローバルクラスターを作成するときに、シャーディング管理モードを構成するには、このフィールドを に設定します。

        false に設定されている場合、マネジメント モードは Atlas マネージド シャーディングに設定されます。このモードはグローバルクラスターのシャーディングを完全に管理し、シームレスな配置エクスペリエンスを提供するように構築されています。

        true に設定されている場合、マネジメント モードは自己管理型シャーディングに設定されます。このモードは、シャードの管理をユーザーに委ね、高度で柔軟な配置エクスペリエンスを提供するように構築されています。

        この設定は、クラスターが配置されると変更できません。

        グローバルクラスターの作成
      • グループ ID string

        プロジェクトを識別するユニークな 24 桁の 16 進数の文字列。

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

      • id string

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

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

      • labels array[オブジェクト] 非推奨

        クラスターにタグを付けて分類する、長さが 1 から 255 文字のキーと値のペアのコレクション。MongoDB Cloud コンソールはラベルを表示しません。

        クラスター ラベルは非推奨であり、将来のリリースで削除される予定です。代わりにリソース タグを使用することを強くお勧めします。

        このMongoDB Cloud コンポーネントに適用された、人間が判読可能なラベル。

        Resource Tags
        ラベル属性を非表示 ラベル属性の表示 オブジェクト
        • キー string

          このコンポーネントをタグ付けおよび分類するために適用されるキー。

          最小長は 1、最大長は 255 です。

        • 価値 string

          このコンポーネントをタグ付けおよび分類するために適用されるキーに設定された値。

          最小長は 1、最大長は 255 です。

      • 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 で始まります。

      • mongoDBEmployeeAccessGrant オブジェクト

        MongoDB 従業員に付与されるクラスターのアクセスレベルと有効期限。

        mongoDBEmployeeAccessGrant 属性を非表示 mongoDBEmployeeAccessGrant 属性の表示 オブジェクト
        • expirationTime string(date-time) 必須

          従業員アクセス権の有効期限。このパラメーターは、UTC の ISO 8601 タイムスタンプ形式で値を表します。

        • granType string 必須

          MongoDB 従業員に付与するアクセス権のレベル。

          値は CLUSTER_DATABASE_LOGS、CLUSTER_INFRASTRUCTURE、または CLUSTER_INFRASTRUCTURE_AND_APP_SERVICES_SYNC_DATA です。

        • 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 で始まります。

      • mongoDBMajorVersion string

        クラスターのMongoDBメジャー バージョン。 バイナリ メジャー バージョンに設定します。

        作成時: 利用可能な MongoDB のバージョンから選択するか、MongoDB Cloud プラットフォームで現在推奨されているデフォルトを未指定のままにします。推奨バージョンは、最新の長期サポートバージョンです。デフォルト設定は、全リリース サイクルを通じて最新のリリース バージョンであることを保証するものではありません。特定のプロジェクトで利用可能なバージョンについては、リンクされたドキュメントを参照するか、プロジェクト LTS バージョン エンドポイントの API エンドポイントを使用してください。

        更新時: 一度に1メジャー バージョンを つだけ上げてください。 クラスターが、現在の MongoDB バージョンより 1 つ下の MongoDB 機能の互換性バージョンに固定されている場合は、MongoDB バージョンはそれ以前のメジャー バージョンにダウングレードできます。

        Atlas で利用可能な MongoDB のバージョン
      • mongoDBVersion string

        クラスターが実行する MongoDB のバージョン。

        形式は次のパターンと一致する必要があります: ([\d]+\.[\d]+\.[\d]+)。

      • name string

        クラスターを識別する人間が判読できるラベル。

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

      • paused ブール値

        クラスターが一時停止しているかどうかを示すフラグ。

      • pitEnabled ブール値

        クラスターが継続的なクラウドバックアップを使用するかどうかを示すフラグ。

        継続的なクラウドバックアップ
      • redactClientLogData ブール値

        ログリダクションを有効または無効にします。

        この設定では、ロギング前に特定のログ イベントに付随するメッセージからドキュメント フィールドの内容をすべて編集するように mongod または mongos を構成します。これにより、データベースに格納されている機密性が高い可能性のあるデータをプログラムが診断ログに書き込むことを防止します。エラー コードや操作 コード、行番号、ソース ファイル名などのメタデータは、引き続きログに表示されます。

        規制要件へのコンプライアンスを支援するため、redactClientLogData を保管時の暗号化および TLS/SSL（トランスポート暗号化）と組み合わせて使用します。

        注: クラスターでこの設定を変更すると、クラスターの更新後すぐにローリング再起動がトリガーされます。

        ログ リダクション
      • replicaSetScalingStratey string

        クラスターのレプリカセット スケーリング モードを構成するには、このフィールドを に設定します。

        デフォルトでは、Atlas は WORKLOAD_Type の下でスケーリングされます。 このモードでは、Atlas は分析ノードを運用ノードと並行して拡張できます。

        SEQUENTIAL として構成すると、Atlas はすべてのノードを順番にスケーリングします。 このモードは、定常状態のワークロードとレイテンシの影響を受けやすいセカンダリ読み取りを実行するアプリケーションを対象としています。

        Node_type として構成すると、Atlas は選択可能なノードを読み取り専用ノードと分析ノードと並行してスケーリングします。 このモードは、頻繁にクラスター階層をスケーリングすることを必要とする大規模で動的ワークロードを対象としています。 これは最速のスケーリング戦略ですが、大量のセカンダリ読み取りを実行するとワークロードのレイテンシに影響を与える可能性があります。

        値は SEQUENTIAL、WORKLOAD_TYPE、または NODE_TYPE です。デフォルト値は WORKLOAD_TYPE です。

        レプリカセットのスケーリングモードの変更
      • replicationSpecs array[オブジェクト]

        クラスター リージョンを構成する設定のリスト。 この配列には、各シャードのノード構成を表すシャードごとに 1 つのオブジェクトが含まれます。 レプリカセットの場合、ノード構成を表すオブジェクトは 1 つだけです。

        MongoDB Cloud が指定されたMongoDBデータベースでデータを複製する方法を説明する詳細。

        replicationSpecs 属性を非表示にする replicationSpecs 属性の表示 オブジェクト
        • id string

          クラスター内のシャードのレプリケーションオブジェクトを識別する一意の 24 桁の 16 進数文字列。リクエストに既存のシャードレプリケーション構成を含める場合は、このパラメーターを指定する必要があります。既存のクラスターに新しいシャードを追加する場合は、このパラメーターを指定できます。リクエストは、 リクエストから除外したクラスター内の既存のシャードを削除します。これは、UIに表示されるシャードIDに対応します。

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

        • regionConfigs array[オブジェクト]

          特定のリージョンに設定されたノードのハードウェア仕様。各regionConfigsオブジェクトは、replicationSpec内のリージョンとクラウドプロバイダーによって一意である必要があります。各regionConfigsオブジェクトは、選挙におけるリージョンの優先順位と、MongoDB Cloud がリージョンに配置するMongoDBノードの数とタイプを記述します。各 regionConfigs オブジェクトには、AnalyticsSpecs オブジェクト、ElectronSpecs オブジェクト、または readOnlySpecs オブジェクトのいずれかが必要です。テナント クラスターには ElectableSpecs のみが必要です。専有クラスターはこれらの仕様のいずれかを指定できますが、 replicationSpec 内に少なくとも 1 つの selectableSpecs オブジェクトが必要です。

          例:

          "replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize" : "M30" を設定する場合は、"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize" : "M 30 " if you have electable nodes and "replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize" を設定します: 読み取り専用ノードがある場合は "M30"。

          次の 1 つ：
          AWSオブジェクト AZUREオブジェクト GCPオブジェクト TENANTオブジェクト
        • zoneId string

          グローバルクラスター内のゾーンを識別する一意な 24 桁の 16 進数文字列。この値は、グローバルクラスターのバックアップポリシーの構成に使用できます。

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

        • zoneName string

          グローバルクラスター内のこのシャードが属するゾーンを説明する、人間が判読可能なラベル。 この値は、 "clusterType" : "GEOSHARDED" であり、 "SelfManagedSharding" : true でない場合にのみ提供します。

      • rootCertType string

        MongoDB Atlasクラスターが使用するルート認証局。MongoDB Cloud は Internet Research Group をサポートしています。

        値は ISRGROOTX1 です。デフォルト値は ISRGROOTX1 です。

      • StateName string

        Atlas コントロール プレーンによってこのクラスターで実行されている現在のアクティビティを示す、人間が判読可能なラベル。CR表現と削除がノードな状態を除く

        • IDLE: Atlas はこのクラスターに変更を加えず、 UIまたはAPI経由でリクエストされたすべての変更が適用されたと想定できます。
        • CREATING: 初めてプロビジョニングされたクラスターは、接続の準備が整うまで状態が CRUDING を返します。接続を試みる前に、 IPアクセス リストと DB ユーザーが設定されていることを確認します。
        • UPDATING: UI、 API、AutoScaling、またはその他のスケジュールされたアクティビティからリクエストされた変更が実行されています。
        • DELETING: クラスターは削除プロセス中であり、すぐに削除される予定です。
        • REPAIRING: クラスター内の 1 つ以上のノードが Atlas コントロール プレーンによって使用可能に返されています。他のノードは、通常どおりサービスを提供し続ける必要があります。

        値は、IDLE、CREATING、UPDATING、DELETING、または REPAIRING です。

      • tags array[オブジェクト]

        クラスターにタグを付けて分類する、長さが 1 から 255 文字のキーと値のペアを含むリスト。

        MongoDB Cloud の組織、プロジェクト、または クラスター をタグ付けして分類するキーと値のペア。例、environment : production。

        Resource Tags
        Hide tags attributes タグ属性の表示 オブジェクト
        • キー string 必須

          タグのセットを定義する定数。 たとえば、 environment : productionタグ内のenvironment 。

          最小長は 1、最大長は 255 です。

        • 価値 string 必須

          タグのセットに属する 変数 。 たとえば、 environment : productionタグ内のproduction 。

          最小長は 1、最大長は 255 です。

      • terminationProtectionEnabled ブール値

        クラスターで終了保護が有効になっているかどうかを示すフラグ。true に設定されていると、MongoDB Cloud はクラスターを削除しません。false に設定されていると、MongoDB Cloud はクラスターを削除します。

        デフォルト値はfalseです。

      • versionReleaseSystem string

        クラスターが MongoDB のバージョンを管理する方法。値が CONTINUOUS の場合、mongoDBMajorVersion を指定しないでください。

        値は LTS または CONTINUOUS です。デフォルト値は LTS です。

    • totalCount integer(int32)

      使用可能なドキュメントの合計数。includeCount が false に設定されている場合、 MongoDB Cloud はこの値を省略します。合計数は推定値であり、正確でない場合があります。

      の最小値は 0 です。
  • 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

      このエラーで返されたアプリケーション エラー メッセージ。
GET /API/Atlas/v2/groups/{groupId}/clusters 
atlas api clusters listGroupClusters --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250219001/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.ListGroupClustersApiParams{}
	sdkResp, httpResp, err := client.ClustersApi.
		ListGroupClustersWithParams(ctx, params).
		Execute()
}

curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-02-19+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2025-02-19+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters?pretty=true"
応答の例（200） 
{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "acceptDataRisksAndForceReplicaSetReconfig": "2025-05-04T09:42:00Z",
      "advancedConfiguration": {
        "customOpensslCipherConfigTls12": [
          "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
        ],
        "minimumEnabledTlsProtocol": "TLS1_0",
        "tlsCipherConfigMode": "CUSTOM"
      },
      "backupEnabled": false,
      "biConnector": {
        "enabled": true,
        "readPreference": "PRIMARY"
      },
      "clusterType": "REPLICASET",
      "configServerManagementMode": "ATLAS_MANAGED",
      "configServerType": "DEDICATED",
      "connectionStrings": {
        "awsPrivateLink": {
          "additionalProperty1": "string",
          "additionalProperty2": "string"
        },
        "awsPrivateLinkSrv": {
          "additionalProperty1": "string",
          "additionalProperty2": "string"
        },
        "private": "string",
        "privateEndpoint": [
          {
            "connectionString": "string",
            "endpoints": [
              {
                "endpointId": "string",
                "providerName": "AWS",
                "region": "string"
              }
            ],
            "srvConnectionString": "string",
            "srvShardOptimizedConnectionString": "string",
            "type": "MONGOD"
          }
        ],
        "privateSrv": "string",
        "standard": "string",
        "standardSrv": "string"
      },
      "createDate": "2025-05-04T09:42:00Z",
      "diskWarmingMode": "FULLY_WARMED",
      "encryptionAtRestProvider": "NONE",
      "featureCompatibilityVersion": "string",
      "featureCompatibilityVersionExpirationDate": "2025-05-04T09:42:00Z",
      "globalClusterSelfManagedSharding": true,
      "groupId": "32b6e34b3d91647abb20e7b8",
      "id": "32b6e34b3d91647abb20e7b8",
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "links": [
        {
          "href": "https://cloud.mongodb.com/api/atlas",
          "rel": "self"
        }
      ],
      "mongoDBEmployeeAccessGrant": {
        "expirationTime": "2025-05-04T09:42:00Z",
        "grantType": "CLUSTER_DATABASE_LOGS",
        "links": [
          {
            "href": "https://cloud.mongodb.com/api/atlas",
            "rel": "self"
          }
        ]
      },
      "mongoDBMajorVersion": "string",
      "mongoDBVersion": "string",
      "name": "string",
      "paused": true,
      "pitEnabled": true,
      "redactClientLogData": true,
      "replicaSetScalingStrategy": "WORKLOAD_TYPE",
      "replicationSpecs": [
        {
          "id": "32b6e34b3d91647abb20e7b8",
          "regionConfigs": [
            {
              "electableSpecs": {
                "diskSizeGB": 42.0,
                "diskIOPS": 42,
                "ebsVolumeType": "STANDARD",
                "instanceSize": "M10",
                "nodeCount": 42
              },
              "priority": 42,
              "providerName": "AWS",
              "regionName": "US_GOV_WEST_1",
              "analyticsAutoScaling": {
                "compute": {
                  "enabled": true,
                  "": "M10",
                  "predictiveEnabled": true,
                  "scaleDownEnabled": true
                },
                "diskGB": {
                  "enabled": true
                }
              },
              "analyticsSpecs": {
                "diskSizeGB": 42.0,
                "nodeCount": 42,
                "diskIOPS": 42,
                "ebsVolumeType": "STANDARD",
                "instanceSize": "M10"
              },
              "autoScaling": {
                "compute": {
                  "enabled": true,
                  "": "M10",
                  "predictiveEnabled": true,
                  "scaleDownEnabled": true
                },
                "diskGB": {
                  "enabled": true
                }
              },
              "readOnlySpecs": {
                "diskSizeGB": 42.0,
                "nodeCount": 42,
                "diskIOPS": 42,
                "ebsVolumeType": "STANDARD",
                "instanceSize": "M10"
              }
            }
          ],
          "zoneId": "32b6e34b3d91647abb20e7b8",
          "zoneName": "string"
        }
      ],
      "rootCertType": "ISRGROOTX1",
      "stateName": "IDLE",
      "tags": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "terminationProtectionEnabled": false,
      "versionReleaseSystem": "LTS"
    }
  ],
  "totalCount": 42
}
応答の例（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"
}