JSON

項目一覧

Atlas CLI コマンドが --fileオプションを受け入れる場合は、 .json構成ファイルを渡して特定の設定を定義できます。たとえば、Atlas CLI を使用して次の操作を行うときに、構成ファイルを渡すことができます。

使用法

Atlas CLI が受け入れる設定を確認するには、リクエスト本文スキーマを表示し、Atlas CLI コマンドに対応するエンドポイントの Atlas Admin API 仕様にあるリクエストサンプルをコピーします。使用できるコマンドには、以下を含むが、これらに限定されません。

Atlas CLI コマンド	API エンドポイント
Atlas クラスター作成	クラスターを 1 つ作成
atlas clusters update	1 つのクラスターの構成を更新
Atlas クラスターのアップグレード	1 つの共有階層クラスターのアップグレード
Atlas バックアップのスケジュールの更新	1つのクラスターのクラウドバックアップスケジュールの更新
Atlas クラスター検索インデックス作成	1 つの Atlas Search インデックスを作成
Atlas クラスター検索インデックスの更新	1 つの Atlas Search インデックスの更新
Atlas クラスター検索ノード作成	検索ノードを作成
Atlas クラスター検索ノードの更新	検索ノードを更新
Atlas dataFederation create	1 つのプロジェクトに 1 つのフェデレーティッドデータベースインスタンスを作成
Atlas アラート設定の作成	1 つのプロジェクトに 1 つのアラート構成を作成する
Atlas アラート設定の更新	1 つのプロジェクトの 1 つのアラート構成の更新
Atlas クラスターインデックス作成	1 つのローリングインデックスを作成
Atlas プロジェクトの更新	1 つのプロジェクトを更新
Atlas federatedAuthentication federationSettings connectOrgConfigs update	1 つのフェデレーションに接続された 1 つの組織構成を更新

ターミナルでコマンドを実行するときに、 --fileオプションを指定し、必要な設定を定義するJSON構成ファイルへのパスを指定します。

例えば、バックアップを有効にしてラベルを追加するには、次の構成ファイルを考慮します。

/example.json

{
  "backupEnabled" : true,
  "labels": [
    {
      "key": "<myKey>",
      "value": "<myValue>"
    }
  ]
}

次のコマンドは、構成ファイルで指定された設定に基づいてmyCluster配置を更新します。

atlas clusters update myCluster --file example.json

クラスター構成ファイルの詳細については、「クラスター構成ファイル」を参照してください。サンプルファイルについては、次を参照してください。

クラウドバックアップスケジュールの構成ファイルの詳細については、「クラウドバックアップスケジュールの構成ファイル」を参照してください。ファイルの構文については、「構成ファイルの作成」を参照してください。

Atlas Search インデックス構成ファイルの詳細については、「 Atlas Searchインデックス構成ファイル」を参照してください。ファイルの構文については、「構成ファイルの作成」を参照してください。

検索ノードの構成ファイルの詳細については、「検索ノードの構成ファイル」を参照してください。ファイルの構文については、「構成ファイルの作成」を参照してください。

Atlas Data Federation の構成ファイルの詳細については、「 Atlas Data Federationの構成ファイル」を参照してください。ファイルの構文については、「構成ファイルの作成」を参照してください。

アラート構成ファイルの詳細については、「アラート構成ファイル」を参照してください。ファイルの構文については、「構成ファイルの作成」を参照してください。

インデックス構成ファイルのローリングの詳細については、「ローリングインデックス構成ファイル」を参照してください。ファイルの例については、次のトピックを参照してください。

To learn more about project configuration files, see Project Configuration File. ファイルの構文については、「構成ファイルの作成」を参照してください。

フェデレーション認証の構成ファイルの詳細については、「フェデレーション認証の構成ファイル」を参照してください。ファイルの構文については、「構成ファイルの作成」を参照してください。

戻る

Atlas CLI の参照

クラスター