atlas api clusters updateCluster

Atlas Administration APIでコマンドを実行中ための Atlas CLI サポートはプレビュー段階です。機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。詳しくは、プレビュー機能を参照してください。

パブリックプレビュー:フィードバックを提供してください : 指定されたプロジェクト内の 1 つのクラスターの詳細を更新します。

パブリックプレビュー: MongoDB Atlas Admin APIから自動的に生成される Atlas APIサブコマンドは、Admin APIの完全なフィードバックを提供し、現在パブリックプレビュー段階です（フィードバック 930808-Atlas-cli ）。管理API機能には独自のリリースライフサイクルがあり、提供されているAPIエンドポイントのドキュメントリンクから確認できます。

クラスターには、同じデータセットを維持するホストのグループが含まれます。このリソースは、非対称サイズのシャードを持つクラスターを更新できます。クラスターの終了保護を更新するには、リクエスト元のサービスアカウントまたはAPIキーにプロジェクトオーナーのロールが必要です。その他のすべての更新では、リクエスト元のサービスアカウントまたはAPIキーにプロジェクトクラスターマネージャーロールが必要です。一時停止中のクラスター（一時停止 : true）を変更することはできません。paused : false を設定するには、このエンドポイントを呼び出す必要があります。このエンドポイントが paused : false で応答したら、クラスターに加える変更を再度呼び出せます。この機能はサーバーレスクラスターでは利用できません。

このコマンドは自動生成され、1:1 と Atlas APIエンドポイント https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-api-v2/operation/operation-updatecluster 。

詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。

構文

コマンド構文

atlas api clusters updateCluster [options]

オプション

名前	タイプ	必須	説明
--clusterName	string	true	クラスターを識別する人間が判読できるラベル。
-- envelope	envelope	false	アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータスパラメータを追加します。
--file	string	false	APIリクエストファイルへのパス。代わりに標準入力を使用するには、を空のままにします。どちらか一方を指定する必要がありますが、両方を指定することはできません。
--groupId	string	true	プロジェクトを識別する一意の 24 桁の 16 進数文字列。 [/groups](# tags/プロジェクト/操作/listProjects) エンドポイントを使用して、認証されたユーザーがアクセスできるすべてのプロジェクトを取得します。注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。
-h, --help		false	updateCluster 用のヘルプ
-o, --output	string	false	優先API形式は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。
-- outputFile	string	false	API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ（例: gzip）で、コマンドがパイプライン化されていない場合（例: Atlas コマンド >out.zip）に必要です。
--pretty		false	レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
--version	string	false	API呼び出しで使用するAPIバージョン [options: "2023-01-01", "2023-02-01", "2024-08-05"、"2024-10-23"] は、デフォルトで最新バージョンになるか、設定されている場合は api_version 構成値をプロファイルします。この値のデフォルトは "2024-10-23" です。
-w, --watch		false	コマンドの実行が完了するまで監視するか、監視がタイムアウトするまで監視するかを示すフラグ。
--watchTimeout	整数	false	監視がタイムアウトするまでの時間（秒単位）。監視がタイムアウトすると、CLI はコマンドの監視を終了します。

継承されたオプション

名前	タイプ	必須	説明
-P, --profile	string	false	構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。

例

クラスターを更新して、ディスクサイズを 20 GBに増やし、ノード数を 5 に増やします

以下のファイルを作成し、保存します payload.json

{
  "replicationSpecs": [
    {
      "regionConfigs": [
        {
          "electableSpecs": {
            "diskSizeGB": 20,
            "instanceSize": "M10",
            "nodeCount": 5
          },
          "priority": 7,
          "providerName": "AWS",
          "regionName": "US_EAST_1"
        }
      ]
    }
  ]
}

payload.json を作成したら、同じディレクトリで以下のコマンドを実行します。

atlas api clusters updateCluster --version 2024-10-23 --clusterName [your-cluster-name] --groupId [your-project-id]