Atlas 项目 apiKeys 创建
创建组织 API 密钥并将其分配给您的项目。
MongoDB仅返回私有API密钥一次。运行此命令后，请立即复制、保存并保护公共和私有API密钥。如果您不提供组织级别角色，则API密钥默认为项目父组织的组织成员。
要使用此命令，您必须使用具有以下任何角色的用户帐户或API密钥进行身份验证：项目用户管理员或组织用户管理员，用于管理组织级别的角色。
语法
atlas projects apiKeys create [options]
选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
--desc | 字符串 | true | API 密钥的描述。 |
-h，--help | false | 创建帮助 | |
-o, --output | 字符串 | false | 输出格式。 有效值为 json、json-path、go-template 或 go-template-file。 要查看完整输出，请使用 -o json 选项。 |
--projectId | 字符串 | false | 标识要使用的项目的十六进制字符串。 此选项会覆盖配置文件或环境变量中的设置。 |
--role | 字符串 | true | 要分配给API密钥的一个或多个角色。要分配多个角色，请为每个角色指定单独的角色标志，或使用一个角色标志将所有角色指定为以逗号分隔的列表。有关接受值的完整列表，请参阅相应Atlas API端点的枚举项：https://www.mongodb.com/zh-cn/docs/atlas/reference/api-resources-spec/v2/#标签/Programmatic- API-Keys/operation/createProjectApiKey。要学习；了解有关项目级用户角色的更多信息，请参阅：https://dochub.mongodb.org/core/atlas-proj-roles。 |
继承选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
-P, --profile | 字符串 | false | 要从配置文件中使用的配置文件的名称。 要了解 Atlas CLI 的配置文件，请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。 |
输出
如果命令成功，CLI 将返回类似于以下示例的输出。 括号中的值代表您的价值观。
API Key '<Id>' created. Public API Key <PublicKey> Private API Key <PrivateKey>
示例
# Create an organization API key with the GROUP_OWNER role and assign it to the project with ID 5e2211c17a3e5a48f5497de3: atlas projects apiKeys create --desc "My API key" --projectId 5e1234c17a3e5a48f5497de3 --role GROUP_OWNER --output json
# Create an organization API key with the GROUP_SEARCH_INDEX_EDITOR and GROUP_DATABASE_ACCESS_ADMIN roles and assign it to the project with ID 5e2211c17a3e5a48f5497de3: atlas projects apiKeys create --desc "My API key" --projectId 5e1234c17a3e5a48f5497de3 --role GROUP_SEARCH_INDEX_EDITOR,GROUP_DATABASE_ACCESS_ADMIN --output json