Docs 菜单
Docs 主页
/ /
Atlas CLI
/ / /

atlas organizations apiKeys list

在此页面上

  • 语法
  • 选项
  • 继承选项
  • 示例

返回组织的所有 API 密钥。

要使用此命令,您必须使用具有“组织成员”角色的用户帐户或 API 密钥进行身份验证。

命令语法
atlas organizations apiKeys list [options]
名称
类型
必需
说明

-c, --compact

false

为 json 输出启用紧凑数组响应结构的标志。 --compact 选项返回数组对象作为顶层响应,并允许基于以前 CLI 版本的脚本向后兼容。 省略 JSON 输出的 --compact 选项会在“结果”子数组中返回数组对象。 必须指定 --output json 才能使用此选项。

-h,--help

false

列表帮助

--limit

int

false

每个结果页面的列项数,最多 500 个。 如果结果超过 500 个,请指定 --page 选项以更改结果页面。 此值默认为 100。

--omitCount

false

指示 JSON 响应是否返回 JSON 响应中的项目总数 (totalCount) 的标志。

--orgId

字符串

false

要使用的组织 ID。 此选项会覆盖配置文件或环境变量中的设置。

-o, --output

字符串

false

输出格式。 有效值为 json、json-path、go-template 或 go-template-file。 要查看完整输出,请使用 -o json 选项。

--page

int

false

指定结果页面的页码。 该值默认为 1。

名称
类型
必需
说明

-P, --profile

字符串

false

要从配置文件中使用的配置文件的名称。 要了解 Atlas CLI 的配置文件,请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。

# Return a JSON-formatted list of organization API keys for the organization with the ID 5a1b39eec902201990f12345:
atlas organizations apiKeys list --orgId 5a1b39eec902201990f12345 --output json

后退

描述