atlas api
実験的な : 実験的な:構文とともに Atlas CLIを使用して、Atlas Administration APIのすべての機能にアクセスします。<tag><operationId>
この実験的な機能は、Atlas CLI を使用して任意の Atlas Administration APIエンドポイントと直接やり取りできるようにすることで、スクリプト開発を効率化します。
- Atlas Administration APIの詳細については、 https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api-resources-spec/v2 /- Atlas Administration APIを使い始める : https://www.mongodb.com/ja-jp/docs/atlas/configure-api-access/#std- labels-atlas-admin-api-access
この実験的な機能は、Atlas CLI を使用して任意の Atlas Administration 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://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |
関連コマンド
Atlas API accessTracking - 実験的な : Atlasデータベース配置に対して行われた認証試行のアクセス ログを返します。
Atlas APIアラート構成 - 実験的な : アラートをトリガーする条件とMongoDB Cloud がユーザーに通知する方法を返却して編集します。
Atlas APIアラート - 実験的な : 定義したアラート条件に基づいてMongoDB Cloud がトリガーするアラートを返し、確認します。
Atlas API atlasSearch - 実験的な : 指定されたクラスターの Atlas Search インデックスを返したり、追加、編集、削除したりします。
Atlas API監査 - 実験的な : MongoDB Cloud プロジェクトのデータベース監査設定を返して編集します。
Atlas API awsClustersDns - 実験的な : Amazon Web ServicesでのMongoDB Cloudデータベース配置のカスタム DNS 構成の返却と編集を行います。
Atlas API cloudBackups - 実験的な : クラウドバックアップ スナップショット、スナップショット エクスポート バケット、復元ジョブ、およびスケジュールを管理します。
Atlas API cloudMigrationService - 実験的な : クラウド移行サービスを管理します。
Atlas API cloudProviderAccess - 実験的な : Atlas でAmazon Web Services IAM ロールを返したり、追加したり、認可したり、削除したりします。
Atlas API clusterOutageSimulation - 実験的な : クラスターの停止時シミュレーションを返したり、開始したり、終了したりします。
Atlas APIクラスター - 実験的な :データベース配置を返したり、追加、編集、削除したりします。
Atlas API collectionLevelMetrics - 実験的な : 指定されたクラスターまたはプロセスの固定された名前空間の返却、追加、編集を行います。
Atlas API customDatabaseRoles - 実験的な : カスタムデータベースユーザーの特権ロールの返却、追加、編集、削除を行います。
Atlas API dataFederation - 実験的な : フェデレーティッドデータベースインスタンスの返却、追加、編集、削除を行います。
Atlas API dataLakeパイプライン - 実験的な : Atlas Data Lake パイプラインおよび関連する実行を返却、編集、削除します。
Atlas API databaseUsers - 実験的な :データベースユーザーを返却、追加、編集、削除します。
Atlas API encryptionAtRestUsingCustomerKeyManagement - 実験的な : カスタマーキー管理の構成を使用して、保管時の暗号化を返却、編集します。
Atlas APIイベント - 実験的な : イベントを返します。
Atlas APIフェデレーティッド認証 - 実験的な : ロール マッピングや接続された組織の構成などのフェデレーション関連の機能の返却、追加、編集、削除を行います。
Atlas API FlexClusters - 実験的な : フレキシブルなクラスターを返したり、追加したり、編集したり、削除したりします。
Atlas API FlexRestoreJobs - 実験的な : フレキシブルなデータベース配置の復元ジョブを返して追加します。
Atlas API FlexSnapshots - 実験的な : フレキシブルなデータベース配置のスナップショットをダウンロードを返し、リクエストします
Atlas API globalClusters - 実験的な : グローバルクラスターで管理されている名前空間とカスタムゾーンマッピングを返却、追加、削除します。
Atlas API請求書 - 実験的な : 請求書を返します。
Atlas API ldapConfiguration - 実験的な : LDAP 構成を返却、編集、検証、削除します。
Atlas API legacyBackup - 実験的な : レガシーバックアップ スナップショット、復元ジョブ、スケジュール、チェックポイントを管理します。
Atlas APIメンテナンスウィンドウ - 実験的な : メンテナンスWindowsを返したり、編集したり、削除したりします。
Atlas API mongoDbCloudUsers - 実験的な : MongoDB Cloud ユーザーを返却、追加、編集します。
Atlas API MonitoringAndLogs - 実験的な :データベース配置のモニタリングとロギングのデータを返します。
Atlas API networkPering - 実験的な : ネットワーク ピアリング コンテナとピアリング接続の返却、追加、編集、削除を行います。
Atlas API OnlineAr Archive - 実験的な : オンライン アーカイブの返却、追加、編集、削除を行います。
Atlas API OpenApi - 実験的な : MongoDB Atlas の仕様に関する情報を返します。
Atlas API組織 - 実験的な : MongoDB Cloud 内の組織単位の返却、追加、編集を行います。
Atlas API performanceAdvisor - 実験的な :データベース配置に推奨されているインデックスと低速クエリ データを返します。
Atlas API privateEndpointServices - 実験的な : プライベートエンドポイントを返し、追加、編集、削除を行います。
Atlas API ProgrammaticApiKeys - 実験的な : MongoDB Cloud APIを使用するためのアクセストークンの返却、追加、編集、削除を行います。
Atlas API projectIpAccessList - 実験的な : Atlas 内のデータベース配置へのネットワークアクセス制限を返したり、追加、編集、削除したりします。
Atlas APIプロジェクト - 実験的な : MongoDB Cloud 内のクラスターとユーザーのコレクションを返したり、追加したり、編集したりします。
Atlas API updateLogExport - 実験的な : mongod、 mongos 、および監査するログからのログをAmazon Web Services S3バケットに継続的にプッシュできます。
Atlas API resourcePolicies - 実験的な :組織内で Atlas リソース ポリシーを構成および管理します 。
Atlas API RunningIndex - 実験的な :データベース配置に 1 つのインデックスをローリング方式で作成します。
Atlas APIルート - 実験的な : MongoDB Cloud ビルドと、このリソースをリクエストするアクセス トークンについて説明する詳細を返します。
Atlas API serverlessInstances - 実験的な : サーバーレスインスタンスを返したり、追加したり、編集したり、削除したりします。
Atlas API serverlessPrivateEndpoints - 実験的な : サーバーレスインスタンスのプライベートエンドポイントを返したり、追加したり、編集したり、削除したりします。
Atlas API serviceAccounts - 実験的な : サービス アカウントとシークレットを管理するためのエンドポイント。
Atlas API SharedTigerRestoreJobs - 実験的な : 共有階層データベース配置の復元ジョブを返して追加します。
Atlas API SharedTerSnapshots - 実験的な : 共有階層データベース配置のスナップショットをダウンロードを返し、リクエストします
Atlas APIストリーム - 実験的な : ストリーム インスタンスを返したり、追加したり、編集したり、削除したりします。
Atlas APIチーム - 実験的な : チームを返したり、追加したり、編集したり、削除したりします。
Atlas APIテスト - 実験的な : Atlas テスト エンドポイント。
Atlas API ThirdPartyIntegration - 実験的な : サードパーティのサービス統合構成を返したり、追加したり、編集したり、削除したりします。
Atlas API x509認証 - 実験的な : ユーザーが管理した X.509 構成を返却、編集、削除します。