Atlas CLI から Atlas Administration APIのすべての機能にアクセスするには、<tag><operationId> コマンドを使用します。
この機能は、Atlas CLI を介して任意の管理APIのエンドポイントとなる接続されたデバイスと直接交流することで、スクリプト開発を効率化します。
Atlas 管理APIの詳細については、次を参照してください: https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-api-v2/- Atlas 管理APIの使用開始: https://www.mongodb.com/ja-jp/docs/atlas/configure-api-access/#std-label-atlas-admin-api-access
atlas api サブコマンドはMongoDB Atlas Admin APIから自動的に生成され、Admin APIの完全なカバレッジを提供します。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントとなる接続されたデバイスのドキュメント リンクから確認できます。
構文
atlas api <tag> <operationId> [options]
重要
<tag> と <operationId> の両方がキャメルケースである必要があります。
Arguments
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
<tag> | string | true | キャメルケース の Atlas Administration API操作のカテゴリです。タグを見つけて形式には、エンドポイントのAPIドキュメントURL を確認します。 例、 |
<operationId> | string | true | キャメルケース の Atlas Administration APIエンドポイントの 識別子 。operationId を見つけるには、エンドポイントのAPIドキュメントURL を確認します。 例、 |
サブコマンド オプション
Atlas Administration APIエンドポイントのパスとクエリ パラメーターをフラグとして渡します。例、エンドポイントが /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId} の場合、Atlas CLI コマンドは次のようになります。
atlas api <tag> <operationId> --orgId <ORG_ID> --invoiceId <INVOICE_ID>
注意
通常、--orgId と --projectId はプロファイルから取得されているため、指定する必要はありません。プロファイルに設定されていない場合にのみ指定します。
エンドポイントに該当する場合は、--file オプションまたは標準入力（stdin）を使用してリクエスト本文を渡します。（例: ）。
atlas api clusters create --file cluster-config.json
さらに、すべての Atlas Administration APIエンドポイントで次のオプションを使用できます。
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| string | false | コマンドの Atlas Administration APIのバージョンを指定します。デフォルトは、最新のAPIバージョンまたはプロファイルで |
| string | false | 出力形式。デフォルトは
エンドポイントでサポートされている形式を確認するには、次の手順を行います。
|
| string | false | 出力を保存するファイル パス。デフォルトでは 、結果はターミナルに表示されます。 |
| string | false | 操作に必要な場合、リクエスト本文へのファイル パス。または、標準入力（ |
| ブール値 | false | 現在のコマンドのヘルプ。 |
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-h, --help | false | ヘルプ (API 用) |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。Atlas CLI のプロファイルの詳細については、https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. を参照してください。 |
関連コマンド
atlas api accessTracking - Atlasデータベース配置に対して行われた認証試行のアクセスログを返します。
atlas api alertConfigurations - アラートをトリガーする条件とMongoDB クラウドがユーザーに通知する方法を返却して編集します。
atlas api アラート - 定義したアラート条件に基づいてMongoDB クラウドがトリガーするアラートを返し、確認します。
Atlas api atlasSearch - 指定されたクラスターの検索インデックスを返したり、追加、編集、除くしたりします。
atlas api 監査する - MongoDB クラウド プロジェクトのデータベース監査設定を返して編集します。
atlas api awsClustersDns - AWSでのMongoDB クラウドデータベース配置のカスタム DNS 構成の返却と編集を行います。
atlas api クラウドバックアップ - クラウドバックアップのスナップショット、スナップショット エクスポート バケット、復元するジョブ、および予定を管理します。
atlas api cloudMigrationService - クラウド移行サービスを管理します。
atlas api cloudProviderAccess - Atlas のAWS IAM ロールの返却、追加、認可、除くを行います。
atlas api clusterOutageSimulation - クラスターの停止時シミュレーションを返したり、開始したり、終了したりします。
atlas api クラスター - データベース配置を返したり、追加、編集、除くしたりします。
atlas api collectionLevelMetrics - 指定されたクラスターまたはプロセスの固定された名前空間の返却、追加、編集を行います。
atlas api customDatabaseRoles - カスタムデータベースユーザーの権限ロールの返却、追加、編集、除くを行います。
atlas api dataFederation - フェデレーティッドデータベースインスタンスの返却、追加、編集、除くを行います。
atlas api データベースユーザー - データベースユーザーを返却、追加、編集、除くします。
atlas api encryptionAtRestUsingCustomerKeyManagement - カスタマーキー・マネジメントを使用して、保管時の暗号化の構成を返却、編集します。
atlas api イベント - イベントを返します。
atlas api federatedAuthentication - ロール マッピングや接続された組織の構成などのフェデレーション関連の機能の返却、追加、編集、除くを行います。
atlas api flexClusters - フレキシブルなクラスターを返したり、追加したり、編集したり、取り除いたりします。
atlas api flexRestoreJobs - フレキシブルなデータベース配置のための復元するジョブを返し、追加します。
atlas api flexSnapshots - フレキシブルなデータベース配置のスナップショットを返し、ダウンロードをリクエストします。
atlas api globalClusters - グローバルクラスターでマネージドされている名前空間とカスタムゾーンマッピングを返却、追加、除外します。
atlas api invoices - 請求書を返します。
atlas api ldapConfiguration - LDAP 設定を返却、編集、検証、除くします。
atlas api レガシーバックアップ - レガシーバックアップのスナップショット、復元ジョブ、スケジュール、チェックポイントを管理します。
atlas api メンテナンスウィンドウ - メンテナンスウィンドウを返却、編集、除きます。
atlas api mongoDbCloudUsers - MongoDB クラウドのユーザーを返却、追加、編集します。
atlas api MongoDBLogs -データベース配置のモニタリングとロギングのデータを返します。
atlas api networkPeering - ネットワーク ピアリング コンテナとピアリング接続の返却、追加、編集、除くを行います。
atlas api オンラインアーカイブ - オンラインアーカイブの返却、追加、編集、除くを行います。
atlas api organizations - MongoDB Cloud 内の組織単位の返却、追加、編集を行います。
atlas api performanceAdvisor -データベース配置に推奨されているインデックスと低速クエリ データを返します。
atlas api privateEndpointServices - プライベートエンドポイントを返し、追加、編集、除きます。
atlas api ProgrammaticApiKeys - MongoDB クラウド APIを使用するためのアクセストークンの返却、追加、編集、除くを行います。
atlas api projectIpAccessList - Atlas 内のデータベース配置へのネットワークアクセス制限を返したり、追加、編集、除いたりします。
atlas api プロジェクト - MongoDB クラウド内のクラスターとユーザーのコレクションを返したり、追加したり、編集したりします。
atlas apipushBasedLogExport - mongod、 mongos 、および監査するログからのログをAWS S3バケットに継続的にプッシュできます。
atlas api resourcePolicies -組織内で Atlas リソース ポリシーを構成および管理します 。
atlas api RunningIndex -データベース配置に 1 つのインデックスをローリング方式で作成します。
atlas api root - MongoDB クラウド ビルドと、このリソースをリクエストするアクセス トークンについて説明する詳細を返します。
atlas api serviceAccounts - サービスアカウントとシークレットを管理するためのエンドポイントとなる接続されたデバイス。
atlas api sharedTierRestoreJobs - 共有階層のデータベース配置に対する復元ジョブを返し、追加します。
atlas api shared階層スナップショット - 共有階層のデータベース配置スナップショットのダウンロードの返却およびリクエストを行います。
atlas api ストリーム - ストリーム インスタンスを返したり、追加したり、編集したり、除いたりします。
atlas api チーム - チームを返したり、追加したり、編集したり、除いたりします。
atlas api thirdPartyIntegrations - サードパーティのサービス統合構成を返したり、追加したり、編集したり、除いたりします。
atlas api x509認証 - ユーザーマネージド X.509 構成を返却、編集、除く。