Atlas CLI から Atlas Administration APIを使用する

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

Atlas CLI には api サブコマンドが用意されており、このサブコマンドを使用すると Atlas CLI からすべての Atlas APIエンドポイントに直接アクセスできます。この機能は、 Atlas APIのすべての機能を使用するための堅牢で確実な方法です。これは Atlas API全体へのアクセスを提供するため、コマンドラインインターフェイスを使用することの利点を持つ任意のタスクをスクリプトや自動化することができます。

Atlas APIとの完全な機能の同等性。
新しい Atlas APIリソースとエンドポイントへのアクセスを高速化します。
オートメーションのための統合された予測可能なコマンド構造。
任意のAPIバージョンを固定する機能。CLI を更新した場合でも、スクリプトが信頼できる状態であり続けます。
操作が完了するまでコマンドを監視する機能。

このチュートリアルでは、Atlas CLI コマンドから Atlas APIを使用する方法を説明します。

注意

APIサブコマンドは Atlas APIから自動的に生成され、Atlas API全体（プレビューリソースを含む）へのアクセスを提供します。この Atlas CLI 機能のメリットを得るには、Atlas APIに関する知識と、デフォルトの入力と出力がAPIメディアタイプを直接マッピングしていることを理解している必要があります。

構文

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

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

Arguments

Argument

必要性

説明

<tag>

必須

APIリソースの Atlas 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バージョンがリリースされた場合に、スクリプトが中断されるのを防ぎます。
`--watch`	任意	操作が完了するまで監視するかどうかを指定するフラグ。

例

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 でコマンドを実行

参照