Docs Menu
Docs Home
/ /
Atlas CLI
/ / /

Atlas projects apiKeys list

項目一覧

  • 構文
  • オプション
  • 継承されたオプション

プロジェクトに割り当てられたすべての組織 API キーを返します。

このコマンドを使用するには、プロジェクト ユーザー管理者ロールのユーザー アカウントまたは API キーで認証する必要があります。

コマンド構文
atlas projects apiKeys list [options]
名前
タイプ
必須
説明

-c, --compact

false

JSON出力の圧縮された配列応答構造を有効にするフラグ。 -- compact オプションは、配列オブジェクトを最上位の応答として返し、以前の CLI バージョンに基づくスクリプトの下位互換性を確保します。 JSON出力の -- compact オプションを省略すると、「結果」サブ配列内の配列オブジェクトが返されます。 このオプションを使用するには --出力JSONを指定する必要があります。

-h, --help

false

リスト用のヘルプ

--limit

整数

false

結果ページあたりの項目数。最大 500 まで。 500 を超える結果がある場合は、結果ページを変更するために --page オプションを指定します。 この値のデフォルトは 100 です。

--omitCount

false

JSON 応答が JSON 応答内の項目の総数( totalCount)を返すかどうかを示すフラグ。

-o, --output

string

false

出力形式。 有効な値は、 JSON 、 JSON -path、go-template、または go-template-file です。 完全な出力を表示するには、 -o JSONオプションを使用します。

--page

整数

false

結果のページを指定するページ番号。 この値のデフォルトは 1 です。

--projectId

string

false

使用するプロジェクトを識別する 16 進数の string。 このオプションは、構成ファイルまたは環境変数の 設定を上書きします。

名前
タイプ
必須
説明

-P, --profile

string

false

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

# Return a JSON-formatted list of organization API keys assigned to the project with ID 5e2211c17a3e5a48f5497de3:
atlas projects apiKeys list --projectId 5e1234c17a3e5a48f5497de3 --output json

戻る

削除