公共预览版：请在以下位置提供反馈：返回指定组织API密钥的一个访问权限列表条目。
资源要求所有 API 请求均源自 API 访问列表上的 IP 地址。请求的 API 密钥必须具备组织成员角色，才能使用此资源。
1此命令是自动生成的，对应于:1 和Atlas API端点 https://www.mongodb.com/zh-cn/docs/atlas/reference/api-resources-spec/v2 /# 标签/Programmatic- API-Keys/operation/getApiKeyAccessList。
有关更多信息和示例，请参阅上面链接的参考API文档。
语法
atlas api programmaticApiKeys getApiKeyAccessList [options]
选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
--apiUserId | 字符串 | true | 唯一的 24 进制数字字符串，用于标识您要为其返回访问列表条目的组织 API 密钥。 |
--envelope | envelope | false | 指示应用程序是否将响应包装在信封JSON对象中的标志。某些API客户端无法访问权限HTTP响应标头或状态代码。要修复此问题，请在查询中设立Envelope=true。返回结果列表的端点将结果对象用作信封。应用程序将状态参数添加到响应正文中。 |
-h，--help | false | getApiKeyAccessList 帮助 | |
--ipAddress | 字符串 | true | 一个 IP 地址或多个 IP 地址表示为一个 CIDR 区块，用于限制对指定组织 API 资源的请求。添加有子网掩码（如 192.0.2.0/24）的 CIDR 区块时，请使用 URL 编码的值 %2F 代替正斜线 /。 |
--orgId | 字符串 | true | 唯一的 24-十六进制数字字符串，用于标识包含项目的组织。 使用 [/orgs](# 标签/Organizations/operation/listOrganizations) 端点检索身份验证的用户有权访问权限的所有组织。 |
--output | 字符串 | false | 首选API格式，可以是 ["JSON", go-template] 此值默认为 "JSON"。 |
--output-file | 字符串 | false | 要将API输出写入其中的文件。 当端点的输出为二进制（例如：gzip）且命令未通过管道传输（例如： Atlas command > out.zip）时，需要使用此标志 |
--pretty | false | 指示响应正文是否应位于 <a href=" https://en.wikipedia.org/wiki/Prettyprint "target="_blank" rel="noopener noreferrer">pretty-print</a> 格式。 | |
--version | 字符串 | false | 进行API调用时要使用的API版本 [选项："2023-01-01"]，默认为最新版本或配置文件 api_version 配置值（如果设立了此值），默认为 "2023-01-01"。 |
继承选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
-P, --profile | 字符串 | false | 要从您的配置文件中使用的配置文件的名称。要学习；了解Atlas CLI配置文件，请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
示例
运行以下命令。
atlas api programmaticApiKeys getApiKeyAccessList --version 2023-01-01 --apiUserId [apiUserId] --envelope false --ipAddress 192.0.2.0%2F24 --orgId 4888442a3354817a7320eb61 --pretty false