Make the MongoDB docs better! We value your opinion. Share your feedback for a chance to win $100.
MongoDB Branding Shape
Click here >
Docs Menu

Atlas API getAccount Details

指定されたグループとリージョンの アカウントIDとVPC IDを返します。

atlas api サブコマンドはMongoDB Atlas Admin APIから自動的に生成され、Admin APIの完全なカバレッジを提供します。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントとなる接続されたデバイスのドキュメント リンクから確認できます。

このコマンドは自動生成され、1:1 と Atlas API エンドポイントとなる接続されたデバイス https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-api-v2/operation/operation-getgroupstreamaccountdetails. に対応しています。

詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。

コマンド構文
atlas api streams getAccountDetails [options]
名前
タイプ
必須
説明

--cloudProvider

string

true

「Amazon Web Services」、「Azure」、または「GCP」のいずれか。

-- envelope

envelope

false

アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

--groupId

string

true

プロジェクトを識別する一意の 24 桁の 16 進数文字列。 [/groups](# tags/プロジェクト/操作/listProjects) エンドポイントを使用して、認証されたユーザーがアクセスできるすべてのプロジェクトを取得します。

: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

-h, --help

false

getAccount Details のヘルプ

-o, --output

string

false

優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。

-- outputFile

string

false

API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ(例: gzip)で、コマンドがパイプライン化されていない場合(例: Atlas コマンド >out.zip)に必要です。

--regionName

string

true

クラウドプロバイダーの特定リージョン名。つまり、クラウドプロバイダー「Amazon Web Services」の「US_EAST_1」。

--version

string

false

Atlas APIエンドポイントを呼び出すときに使用するAPIバージョン [options: "2024-11-13"] 。ユーザーによって設定されない場合は、デフォルトで最新バージョンになるか、プロファイルの api_version 構成値 (設定されている場合)になります。この値のデフォルトは "2024-11-13" です。

名前
タイプ
必須
説明

-P, --profile

string

false

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

atlas api streams getAccountDetails --version 2024-11-13 --cloudProvider [cloudProvider] --groupId 32b6e34b3d91647abb20e7b8 --regionName [regionName]