返回组织的指定 API 密钥的详细信息。
要查看ID参数的可能值，请运行mongocli iam organizations apiKeys list。
要使用此命令，您必须使用具有“组织成员”角色的用户帐户或 API 密钥进行身份验证。
语法
命令语法
mongocli iam organizations apiKeys describe <ID> [options]
参数
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
id | 字符串 | true | 标识 API 密钥的唯一的 24 位字符串。 |
选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
-h，--help | false | 描述帮助 | |
--orgId | 字符串 | false | 要使用的组织 ID。 此选项会覆盖配置文件或环境变量中的设置。 |
-o, --output | 字符串 | false | 输出格式。 有效值为 json、json-path、go-template 或 go-template-file。 要查看完整输出，请使用 -o json 选项。 |
继承选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
-P, --profile | 字符串 | false | 要从您的配置文件中使用的配置文件的名称。要学习；了解MongoCLI 的配置文件，请参阅 https://dochub.mongodb.org/core/atlas-cli-configuration-file. |
输出
如果命令成功，CLI 将返回类似于以下示例的输出。 括号中的值代表您的价值观。
ID DESCRIPTION PUBLIC KEY PRIVATE KEY <ID> <Desc> <PublicKey> <PrivateKey>
示例
# Return the JSON-formatted details for the organization API key with the ID 5f24084d8dbffa3ad3f21234 for the organization with the ID 5a1b39eec902201990f12345: mongocli iam organizations apiKeys describe 5f24084d8dbffa3ad3f21234 --orgId 5a1b39eec902201990f12345 -output json