Atlas CLI から Atlas Administration APIのすべての機能にアクセスするには、<tag><operationId> コマンドを使用します。
この機能は、Atlas CLI を介して任意の Atlas Administration APIエンドポイントと直接やり取りできるため、スクリプト開発を効率化します。
- Atlas Administration APIの詳細については、 https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-api-v2 / - Atlas Administration APIを使い始める : https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-api-v / https://www.mongodb.com/ja-jp/docs/atlas/configure-api-access/#std- labels-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 Cloud がユーザーに通知する方法を返却して編集します。
atlas api alerts - 定義したアラート条件に基づいてMongoDB Cloud がトリガーするアラートを返し、確認します。
atlas api atlasSearch - 指定されたクラスターの Atlas Search インデックスを返したり、追加、編集、削除したりします。
atlas api auditing - MongoDB Cloud プロジェクトのデータベース監査設定を返して編集します。
atlas api awsClustersDns - AWSでのMongoDB Cloudデータベース配置のカスタム DNS 構成の返却と編集を行います。
atlas api cloudBackups - クラウドバックアップ スナップショット、スナップショット エクスポート バケット、復元ジョブ、およびスケジュールを管理します。
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 databaseUsers -データベースユーザーを返却、追加、編集、削除します。
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 legacyBackup - レガシーバックアップ スナップショット、復元ジョブ、スケジュール、チェックポイントを管理します。
atlas apimationWindows - メンテナンスウィンドウを返却、編集、削除します。
atlas api mongoDbCloudUsers - MongoDB Cloud ユーザーを返却、追加、編集します。
atlas api MongoDBLogs -データベース配置のモニタリングとロギングのデータを返します。
atlas api networkPering - ネットワーク ピアリング コンテナとピアリング接続の返却、追加、編集、削除を行います。
atlas api OnlineAr Archive - オンライン アーカイブの返却、追加、編集、削除を行います。
atlas api organizations - MongoDB Cloud 内の組織単位の返却、追加、編集を行います。
atlas api performanceAdvisor -データベース配置に推奨されているインデックスと低速クエリ データを返します。
atlas api privateEndpointServices - プライベートエンドポイントを返し、追加、編集、削除を行います。
atlas api ProgrammaticApiKeys - MongoDB Cloud API を使用するためのアクセストークンの返却、追加、編集、削除を行います。
atlas api projectIpAccessList - Atlas 内のデータベース配置へのネットワークアクセス制限を返したり、追加、編集、削除したりします。
atlas api プロジェクト - MongoDB Cloud 内のクラスターとユーザーのコレクションを返したり、追加したり、編集したりします。
atlas apipushBasedLogExport - mongod、 mongos 、および監査するログからのログをAWS S3 バケットに継続的にプッシュできます。
atlas api resourcePolicies -組織内で Atlas リソース ポリシーを構成および管理します 。
atlas api RunningIndex -データベース配置に 1 つのインデックスをローリング方式で作成します。
atlas api root - MongoDB Cloud ビルドと、このリソースをリクエストするアクセス トークンについて説明する詳細を返します。
atlas api serviceAccounts - サービスアカウントとシークレットを管理するためのエンドポイント。
atlas apisharedTigerRestoreJobs - 共有階層データベース配置の復元ジョブを返して追加します。
atlas apisharedTerSnapshots - 共有階層データベース配置のスナップショットをダウンロードを返し、リクエストします
atlas apistreams - ストリーム インスタンスを返したり、追加したり、編集したり、削除したりします。
atlas api チーム - チームを返したり、追加したり、編集したり、削除したりします。
atlas api ThirdPartyIntegration - サードパーティのサービス統合構成を返したり、追加したり、編集したり、削除したりします。
atlas api x509 認証 - ユーザーが管理する X.509 構成を返却、編集、削除します。