Docs Menu
Docs Home
/
MongoDB Atlas
/
Atlas App Services
/
参照

Atlas App Services CLI

項目一覧

  • Overview
  • インストール
  • 認証
  • .mdbディレクトリ
  • CLI プロファイル
  • オプション
  • 関連コマンド

Overview

Atlas App Services コマンドライン インターフェイス（ appservicesを使用すると、アプリケーションをプログラムで管理できます。

App Services CLI を使用すると、ローカル ディレクトリからアプリを作成またはアップデートしたり、既存のアプリケーションをローカル ディレクトリにエクスポートしたりできます。

インストール

App Services CLI はnpmで利用できます。 システムに CLI をインストールするには、 Node.js があることを確認してくださいがインストールされたら、shell で次のコマンドを実行します。

npm install -g atlas-app-services-cli

認証

App Services CLI を使用するには、認証が必要です。 認証するには、API キーを生成する必要があります。

API キーの生成

1

MongoDB Cloud Access Manager への移動

MongoDB Cloud Access Managerを使用すると、ユーザー、チーム、API キーのプロジェクトへのアクセスを管理できます。 プロジェクト アクセス マネージャーを使用するには、画面左上にあるProject Access access manager dropdown [] タブをクリックします。

[アクセス マネージャー] をクリックします
クリックして拡大します
2

API キーの作成

プロジェクト ユーザーは、プロジェクト API キーを使用してログインできます。 プロジェクト アクセス マネージャーの右側にある灰色のCreate API Key ] ボタンをクリックして、プロジェクト API キーを作成します。

[アクセス マネージャー] をクリックします
クリックして拡大します

このボタンをクリックすると、「Create API Key」画面に移動します。 キーの説明を設定します。

書き込みアクセスするには、CLI に「プロジェクト オーナー」権限を持つ API キーが必要です。 読み取り専用アクセスの場合は、「プロジェクト読み取り専用」を使用できます。 [ Project Permissions ] ドロップダウンを使用して、ユースケースに適した権限を選択します。

後でログインするために使用する公開鍵をコピーします。 キーの詳細の設定を続行するには、 nextをクリックします。

[アクセス マネージャー] をクリックします
クリックして拡大します
3

APIアクセス リストを設定する

後で使用するために秘密キーを安全な場所にコピーします。 セキュリティのため、初期化後に秘密キーが再度表示されることはありません。 別のセキュリティ機能は、 API アクセス リスト です。 API アクセス リスト エントリを作成すると、API 呼び出しは許可された IP から確実に起動されます。

API キーを使用するには、 API キーを使用するユーザーの IP アドレスが必要です。 [ Add Access List Entry ] ボタンをクリックします。 IP アドレスを入力するか、 Use Current IP Addressボタンをクリックして保存をクリックします。 最後に、画面の右下にある [ Done ] ボタンをクリックして、API キーの設定を終了します。

[アクセス マネージャー] をクリックします
クリックして拡大します

API キーによる認証

1

CLI ユーザーの認証

新しく作成した公開キーと秘密キーを使用して、以下のコマンドを実行してログインします。

appservices login --api-key="<my api key>" --private-api-key="<my private api key>"

次の結果が表示されます。

you have successfully logged in as <your public key>

The ディレクトリ.mdb

App Services CLI を使用して構成ファイルをプッシュまたはプルすると、CLI はアプリケーション構成の.mdbディレクトリに操作するアプリに関する情報を保存します。 これにより、CLI は複数のコマンドにわたって構成ファイルに関連付けられている特定の配置を記憶できるようになります。

このディレクトリはマシンで生成されたものであり、通常、手動で変更しないでください。 .mdbディレクトリを削除すると、CLI は構成ファイルを特定の配置に関連付けることができなくなります。 CLI では、特定のデプロイを対象とするコマンドを実行すると、新しい.mdbディレクトリが作成されます。

CLI は識別子と構成メタデータを.mdb/meta.jsonファイルに保存します。このファイルの形式は次のとおりです。

{
  "config_version": 20230101,
  "app_id": "42249d526d97af5a287c1eae",
  "group_id": "4b2cf422930196872221a2d4",
  "client_app_id": "myapp-abcde"
}
フィールド
説明
config_version
number
ディレクトリ内のすべての構成ファイルが準拠する構成ファイル形式のバージョン。 これは、CLI が構成ファイルを読み取れるようにするために使用されます。
app_id
string
アプリの内部 ObjectId 値。
group_id
string
アプリが関連付けられている Atlas プロジェクト ID。
client_app_id
string
人間が判読可能なクライアント アプリ ID。

CLI プロファイル

CLI は、ユーザーに関する情報をプロファイルに保存します。 これにより、指定されたコンテキストでコマンドを実行できるようになります。 たとえば、Atlas Admin API キーを使用してログインすると、CLI は API キーと現在のセッション アクセス トークンを保存します。 その後、有効期限が切れるまで、後続の コマンドでそのトークンを再利用します。

複数の名前付きプロファイルを設定し、任意の CLI コマンドに使用するプロファイルを選択することができます。 指定しない場合、CLI はデフォルトの プロファイルを使用します。このプロファイルはdefaultという名前のプロファイルです。

プロファイルを指定するには、任意のコマンドに--profile引数を追加します。 たとえば、 my-profileという名前の新しいプロファイルでログインするには、次のコマンドを実行します。

appservices login --profile my-profile

ログインすると、同じプロファイルの他のコマンドを実行できます。

appservices pull --remote=myapp-abcde --profile my-profile

CLI コマンドを使用して、システム上のすべてのプロファイルを一覧表示できます。

appservices profiles list
Found 2 profile(s)
  Profile     API Key
  ----------  -----------------------------------------------
  my-profile  rjxerfwi (********-****-****-****-f00b471ec015)
  default     xkwwtlmj (********-****-****-****-f03b321dae23)

CLI は、コンピューター上のプロファイルを、プロファイルにちなんで命名された個別の構成ファイルに保存します。 プロファイル定義のロケーションは システムによって異なります。

オペレーティング システム
プロファイル ディレクトリ
Unix / Linux
$XDG_CONFIG_HOME/<profile>.yaml or $HOME/.config/<profile>.yaml
MacOS
$HOME/Library/Application\ Support/appservices-cli/<profile>.yaml
Windows
%AppData%/<profile>.yaml

オプション

名前
タイプ
必須
説明
--profile
string
false
プロファイルを指定します（デフォルト値: "default"）[詳細はこちら ]
--telemetry
string
false
現在のプロファイルの CLI 使用量の追跡を有効または無効にします（デフォルト値: "on"、許可値: "on"、"op"）
-o, --output-target
string
false
指定されたファイルパスへの CLI 出力の書込み (write)
-f, --output-format
string
false
CLIの出力形式を設定する（デフォルト値:<blank> 、許可値:<blank> 、"JSON "）
--disable-colors
false
すべての CLI 出力スタイル（例: 色、フォント スタイルなど）
-y, --yes
false
必要なユーザー プロンプトに同意して、CLI コマンドを自動的に続行します
-h, --help
false
appservices のヘルプ

関連コマンド

  • appservices accessList - アプリの許可された IP アドレスと CIDR ブロックを管理します（アクセスリスト、アクセス リストのエイリアス）

  • appservices アプリ- 現在のユーザーに関連付けられている App Service アプリを管理します（エイリアス: アプリ）

  • appservices deployment - アプリの自動配置の管理

  • appservices 関数- アプリの関数（エイリアス: 関数）を操作します

  • appservices login - MongoDB Cloud API キーを使用して CLI を App Services にログインします

  • appservices logout - CLI を App Services からログアウトさせます

  • appservices logs - アプリのログを操作します（エイリアス: log）

  • appservices Pull - アプリの最新バージョンをローカル ディレクトリに取得します

  • appservicespush - ローカル ディレクトリからの変更をアプリにプッシュして配置します

  • appservices schema - アプリのスキーマを管理します（エイリアス: スキーマ）

  • appservices secrets - アプリのシークレットを管理します（エイリアス: secret）

  • appservices users - アプリのユーザー数を管理します（エイリアス: user）

  • appservices whatmi-現在のユーザーに関する情報を表示する

戻る