文档菜单
文档首页
/ /
MongoDB CLI
/ / /

mongocli iam globalApiKeys create

本页内容

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

为您的Ops Manager实例创建全局API密钥。

命令语法
mongocli iam globalApiKeys create [options]
名称
类型
必需
描述
--desc
字符串
true
API密钥的描述。
-h, --help
false
创建的帮助信息
-o, --output
字符串
false
输出格式。有效值有json、json-path、go-template或go-template-file。要查看完整的输出,请使用-o json选项。
--role
字符串
true
您想要分配给API密钥的角色或角色列表。要分配多个角色,您可以使用单独的角色标志指定每个角色,或者使用一个角色标志指定所有角色,以逗号分隔。有效值有GLOBAL_AUTOMATION_ADMIN、GLOBAL_BACKUP_ADMIN、GLOBAL_MONITORING_ADMIN、GLOBAL_OWNER、GLOBAL_READ_ONLY、GLOBAL_USER_ADMIN。
名称
类型
必需
描述
-P, --profile
字符串
false
要使用的配置文件中的配置文件名称。有关MongoCLI配置文件的配置文件信息,请参阅https://dochub.mongodb.org/core/atlas-cli-configuration-file.
# Create a global API key that grants GLOBAL_READ_ONLY and GLOBAL_USER_ADMIN access for your Ops Manager instance:
mongocli iam globalApiKeys create --desc "My Global API key" --role "GLOBAL_READ_ONLY","GLOBAL_USER_ADMIN" --output json

返回

全局API密钥