Docs 菜单

Docs 主页启动和管理 MongoDBAtlas CLI

atlas organizations apiKeys accessLists create

在此页面上

  • 语法
  • 选项
  • 继承选项
  • 输出
  • 举例

为 API 密钥创建 IP 访问列表条目。

要查看 apiKey 选项的可能值,请运行 atlas organizations apiKeys list。

要使用此命令,您必须使用具有读写角色的用户帐户或 API 密钥进行身份验证。

命令语法
atlas organizations apiKeys accessLists create [options]
名称
类型
必需
说明
--apiKey
字符串
true
用于标识 API 密钥的唯一 24 位 ID。
--cidr
字符串
false
要为 API 密钥添加的访问列表条目(采用 CIDR 表示法)。 要添加多个条目,您可以使用单独的 CIDR 标志指定每个条目,或使用一个 CIDR 标志将所有条目指定为逗号分隔的列表。 不能在同一命令中同时设置 CIDR 和 IP。
--currentIp
false
将当前正在执行命令的主机的 IP 地址添加到访问列表的标志。 仅适用于 ipAddress 类型的条目。 使用 currentIp 选项时,不需要条目参数。
-h,--help
false
创建帮助
--ip
字符串
false
要添加到 API 密钥访问列表的 IP 地址。 要添加多个 IP 地址,请使用单独的 ip 标志指定每个地址,或使用一个 ip 标志将所有地址指定为逗号分隔的列表。 不能在同一命令中同时设置 IP 和 CIDR。
--orgId
字符串
false
要使用的组织 ID。 此选项会覆盖配置文件或环境变量中的设置。
-o, --output
字符串
false
输出格式。 有效值为 json、json-path、go-template 或 go-template-file。 要查看完整输出,请使用 -o json 选项。
名称
类型
必需
说明
-P,--profile
字符串
false
要从配置文件中使用的配置文件的名称。要了解 Atlas CLI 的配置文件,请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。

如果命令成功,CLI 将返回类似于以下示例的输出。 括号中的值代表您的价值观。

Created new access list entry(s).
# Create access list entries for two IP addresses for the API key with the ID 5f24084d8dbffa3ad3f21234 in the organization with the ID 5a1b39eec902201990f12345:
atlas organizations apiKeys accessLists create --apiKey 5f24084d8dbffa3ad3f21234 --cidr 192.0.2.0/24,198.51.100.0/24 --orgId 5a1b39eec902201990f12345 --output json
← atlas organizations apiKeys accessLists