Docs Menu
Docs Home
/
MongoDB Atlas
/
Atlas CLI
/
コマンド

atlas api

パブリック プレビュー: <https://フィードバック.mongodb.com/forms/930808-atlas-cli> でフィードバックを提供してください。Atlas Administration APIのすべての機能にアクセスするには、次の構文を指定して Atlas CLI を使用し ます : 'Atlas API <tag> <operationId>'

public previewのこの機能は、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

public previewのこの機能は、Atlas CLI を使用して任意の Atlas Administration APIエンドポイントと直接やり取りできるため、スクリプト開発を効率化します。

構文

コマンド構文
atlas api <tag> <operationId> [options]

重要

<tag> と <operationId> の両方がキャメルケースである必要があります。

Arguments

名前
タイプ
必須
説明

<tag>

string

true

キャメルケース の Atlas Administration API操作のカテゴリです。タグを見つけて形式には、エンドポイントのAPIドキュメントURL を確認します。#tag/ の後に表示されますが、キャメルケースに変更する必要があります。Atlas APIドキュメントについては、 https://www.mongodb.com/ja-jp/docs/atlas/参照/api-resources-spec/v2/ を参照してください。

例、https://www.mongodb.com/ja-jp/docs/atlas/reference/api-resources-spec/v2/#tag/Monitoring-and-Logs では、タグは Monitoring-and-Logs です。キャメルケースでは monitoringAndLogs です。

<operationId>

string

true

キャメルケース の Atlas Administration APIエンドポイントの 識別子 。operationId を見つけるには、エンドポイントのAPIドキュメントURL を確認します。operation/ の後に表示されます。Atlas APIドキュメントについては、 https://www.mongodb.com/ja-jp/docs/atlas/参照/api-resources-spec/v2/ を参照してください。

例、https://www.mongodb.com/ja-jp/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/operation/listClusters では、 operationId は listClusters です。

サブコマンド オプション

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エンドポイントで次のオプションを使用できます。

名前
タイプ
必須
説明

--api-version

string

false

コマンドの Atlas Administration APIのバージョンを指定します。デフォルトは、最新のAPIバージョンまたはプロファイルで api_version に設定した値が含まれます。

--out

string

false

出力形式。デフォルトは json ですが、サポートされている形式はエンドポイントによって異なる場合があります。

  • ほとんどのエンドポイントは json を出力します。json がサポートされている場合は、 Goテンプレートも使用できます。

  • 一部のエンドポイントは json と csv をサポートしており、json、csv、またはGoテンプレートを使用できます。

  • 特定のエンドポイントはバイナリ データを出力します（例、 、 gzip形式のログ）には --out オプションが必要です。

エンドポイントでサポートされている形式を確認するには、次の手順を行います。

-o, --out-file

string

false

出力を保存するファイル パス。デフォルトでは 、結果はターミナルに表示されます。

--file

string

false

操作に必要な場合、リクエスト本文へのファイル パス。または、標準入力（stdin）を介して入力を提供します。

-h, --help

ブール値

false

現在のコマンドのヘルプ。

オプション

名前
タイプ
必須
説明

-h, --help

false

ヘルプ (API 用)

継承されたオプション

名前
タイプ
必須
説明

-P, --profile

string

false

構成ファイルから使用するプロファイルの名前。Atlas CLI のプロファイルの詳細については、https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. を参照してください。

関連コマンド

項目一覧