実験的な : 指定された組織のすべての組織APIキーを返します。
組織APIキーは、組織へのプログラムによるアクセスを許可します。APIキーを使用してコンソール経由でMongoDBクラウドにログすることはできません。このリソースを使用するには、リクエスト元のAPIキーに組織メンバーロールが必要です。このコマンドは、OperationID: 'listApiKeys' を使用してエンドポイントを呼び出しています。フラグ、--ファイルの形式、および例の詳細については、次を参照してください: https://www.mongodb.com/ja-jp/docs/atlas/ 参照/api-resources-spec/v2 /# tags/Programmatic- API-キー/操作/listApiKeys
構文
atlas api programmaticApiKeys listApiKeys [options]
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-- envelope | false | アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ | |
-h, --help | false | listApiKeys のヘルプ | |
--includeCount | false | レスポンスがレスポンス内の項目の総数（totalCount）を返すかどうかを示すフラグ | |
--itemsPerPage | 整数 | false | レスポンスが返す 1 ページあたりの項目の数 |
--orgId | string | true | プロジェクトを含む組織を識別する一意の 24 桁の 16 進数文字列 |
--出力 | string | false | 優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。 |
-- output-file | string | false | API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ（例: gzip）で、コマンドがパイプライン化されていない場合（例: Atlas コマンド >out.zip）に必要です。 |
--pageNum | 整数 | false | レスポンスが返す合計オブジェクト数の現在のセットを表示するページの番号 |
--pretty | false | レスポンス本体を pretty-print形式にするかどうかを示すフラグ | |
--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 を参照してください。 |