パブリック プレビュー: にフィードバックを提供してください: 名前で識別されるプロジェクトの詳細を返します。
プロジェクトは、アプリケーション環境、ワークロード、またはその両方をサポートする論理コレクションにクラスターをグループ化します。各プロジェクトには、独自のユーザー、チーム、セキュリティ、タグ、アラート設定を設定できます。このリソースを使用するには、リクエスト元の API キーにプロジェクトの読み取り専用ロールが必要です。
このコマンドは自動生成され、:1 と1 Atlas APIエンドポイント https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api-resources-spec/v2 /# tags/Projects/ /getProjectByNameの操作。
詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。
構文
atlas api projects getProjectByName [options]
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-- envelope | envelope | false | アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。 |
--groupName | string | true | このプロジェクトを識別する、人間に判読可能なラベル。 |
-h, --help | false | getProjectByName のヘルプ | |
--出力 | string | false | 優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。 |
-- output-file | string | false | API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ（例: gzip）で、コマンドがパイプライン化されていない場合（例: Atlas コマンド >out.zip）に必要です。 |
--pretty | false | ||
--version | string | false | API 呼び出し [options: "2023-01-01"] を呼び出すときに使用する API バージョンは、最新バージョンにデフォルト設定されているか、設定されている場合は api_version 構成値 をプロファイルします。この値のデフォルトは "2023-01-01" |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |
例
以下の コマンドを実行します。
atlas api projects getProjectByName --version 2023-01-01 --envelope false --groupName [groupName] --pretty false