Docs Menu
Docs Home
/
MongoDB Atlas
/
Atlas CLI
/
Atlas の管理

Atlas Administration APIを使用した Atlas CLI コマンドの実行

このチュートリアルでは、 Atlas Administration APIを使用して Atlas CLI コマンドを実行する方法を説明します。Atlas CLI からすべての Atlas Administration APIリソースとエンドポイントを使用して、Atlas 配置を作成および管理できます。Atlas Administration APIの Atlas CLI サポートには次のメリットがあります。

  • Atlas APIとの完全な機能の同等性。

  • 新しい Atlas APIリソースとエンドポイントへのアクセスを高速化します。

  • オートメーションのための統合された予測可能なコマンド構造。

  • 任意のAPIバージョンを固定する機能。CLI を更新した場合でも、スクリプトが信頼できる状態であり続けます。

構文

Atlas APIで Atlas CLI を使用するには、次の形式でコマンドを実行します。

atlas api <tag> <operationId> [options]|--file <fileName>.json --version <api-resource-version>

Arguments

Argument
必要性
説明

<tag>

必須

Atlas APIドキュメントで使用されるタグの名前: APIリソースのURL 。タグは、Atlas 管理APIドキュメントURLのハイフンで区切られています。ただし、 Atlas CLI コマンド構文でキャメルケースに変換する必要があります。

例、Atlas Administration APIリソースの次のURLを考えてみましょう。

https://www.mongodb.com/ja-jp/docs/atlas/reference/api-resources-spec/v2/#tag/Example-Tag-Name/

上記のURLのリソースにアクセスするには、 コマンド構文で <tag> を exampleTagName に置き換えます。

atlas api exampleTagName <operationId>

その他の例については、の例を参照してください。

<operationId>

必須

APIエンドポイントのAtlas Administration APIドキュメントURL内の操作の識別子。値はキャメルケース形式です。

Atlas APIエンドポイント操作の次のURLを例に考えてみましょう。

https://www.mongodb.com/ja-jp/docs/atlas/reference/api-resources-spec/v2/#tag/Example-Tag-Name/operation/exampleEndpointOperationId

上記のURLでエンドポイントでサポートされている操作を実行するには、<tag> を exampleTagName に置き換え、 コマンドに示すように、操作のIDである exampleEndpointOperationId を使用します。

atlas api exampleTagName exampleEndpointOperationId [options]

その他の例については、例を参照してください。

オプション

コマンドのオプションとして、 APIパス、クエリ、リクエストの本体パラメータを渡すことができます。コマンドを使用してオプションを直接指定することも、JSONファイルを使用してオプションを直接指定することもできます。コマンドは、次のオプションもサポートしています。

オプション
必要性
説明

--file

条件付き

操作のAPIパス、クエリ、リクエスト本体パラメータを含むJSONファイル。これは、コマンドで直接指定していない操作に必要なパス、クエリ、またはリクエストの本体パラメータがある場合にのみ必要です。

--version

任意

使用するAPIリソースバージョン。スクリプトを特定のAPIバージョンに固定するために、省略した場合、コマンドはデフォルトで最新バージョン（またはプロファイルの構成済みバージョン）になります。ただし、スクリプトの安定性を確保するために、バージョンを明示的に設定することをお勧めします。これにより、互換性のない変更で新しいAPIバージョンがリリースされた場合に、スクリプトが中断されるのを防ぎます。

例

Atlas Administration APIを使用した次の Atlas CLI コマンドは、指定されたプロジェクトの指定されたホストのログメッセージの範囲を含む圧縮（.gz）ログファイルを検索する方法を示しています。

atlas api monitoringAndLogs getHostLogs --groupId 5e2211c17a3e5a48f5497de3 --hostName mycluster-shard-00-02.7hgjn.mongodb.net --logName mongodb --output gzip --version 2025-03-12

Atlas Administration APIを使用した次の Atlas CLI コマンドは、--file オプションを使用してクラスターを作成する方法を示しています。

atlas api clusters createCluster --groupId 5e2211c17a3e5a48f5497de3 --file cluster-config.json --version 2025-03-12

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

Atlas Administration APIを使用した次の Atlas CLI コマンドは、リージョンにおけるクラウドプロバイダーの停止をシミュレートする方法を示しています。このシミュレーションにより、アプリケーションのフェイルオーバー動作と障害復旧手順を、本番環境とは別の制御された環境でテストできます。コマンドは、次の設定を持つ outage_simulation.json という名前のファイルを使用します。

{
   "outageFilters": [
      {
         "cloudProvider": "AWS",
         "regionName": "US_EAST_1",
         "type": "REGION"
      }
   ]
}
atlas api clusterOutageSimulation startOutageSimulation --groupId 5e2211c17a3e5a48f5497de3 --clusterName myCluster --file outage_simulation.json --version 2025-03-12
{"clusterName":"myCluster","groupId":"5e2211c17a3e5a48f5497de3","id":"6808ed9bed0b0b51caee336b","outageFilters":[{"cloudProvider":"AWS","regionName":"US_EAST_1","type":"REGION"}],"startRequestDate":"2025-04-23T13:39:39Z","state":"START_REQUESTED"}

戻る

Docker でコマンドを実行

次へ

参照

項目一覧