使用您通过云提供商管理的密钥更新静态加密配置。
atlas api 子命令是从 MongoDB Atlas Admin API 自动生成的，并提供对 Admin API 的全面覆盖。Admin API功能有自己的发布生命周期，您可以通过提供的API终结点文档链接进行检查。
即使您不使用自己的密钥管理， MongoDB Cloud 也会加密所有存储。此资源要求请求的服务帐户或API密钥具有项目所有者角色。此功能不适用于 M0 免费集群、M2、M5 或无服务器集群。
使用客户密钥管理提供程序为 MongoDB Cloud 项目配置至少一项静态加密后，项目所有者可以为需要加密的每个 MongoDB Cloud 集群启用使用客户密钥管理的静态加密。使用客户密钥管理提供程序的静态加密不必与集群云服务提供商匹配。MongoDB Cloud 不会自动轮换用户管理的加密密钥。使用客户密钥管理提供程序的文档和密钥轮换最佳实践指南，遵循您首选的静态加密。当您在 MongoDB Cloud 项目中使用密钥管理配置使用客户密钥管理的静态加密时，MongoDB Cloud 会自动创建 90 天密钥轮换警报。无论您是否使用自己的密钥管理，MongoDB Cloud 都会加密所有存储。
此命令是自动生成的，对应 1:1 与 Atlas API 终结点 https://www.mongodb.com/zh-cn/docs/api/doc/atlas-admin-api-v2/operation/operation-updategroupencryptionatrest.
有关更多信息和示例，请参阅上面链接的参考API文档。
语法
atlas api encryptionAtRestUsingCustomerKeyManagement updateEncryptionAtRest [options]
选项
名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
--envelope | envelope | false | 指示应用程序是否将响应包装在信封JSON对象中的标志。某些API客户端无法访问权限HTTP响应标头或状态代码。要修复此问题，请在查询中设立Envelope=true。返回结果列表的端点将结果对象用作信封。应用程序将状态参数添加到响应正文中。 |
--file | 字符串 | false | API请求文件的路径。留空可使用标准输入 - 您必须提供其中之一，但不能同时提供两者。 |
--groupId | 字符串 | true | 用于标识项目的唯一 24-十六进制数字字符串。 使用 [/groups](# 标签/Projects/operation/listProjects) 端点检索身份验证的用户有权访问权限的所有项目。 注意：群组和项目是同义词。您的群组 ID 与项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。资源和相应的端点使用“群组”一词。 |
-h，--help | false | updateEncryptionAtRest 帮助 | |
-o, --output | 字符串 | false | 首选API格式，可以是 ["JSON", go-template] 此值默认为 "JSON"。 |
--outputFile | 字符串 | false | 要将API输出写入其中的文件。 当端点的输出为二进制（例如：gzip）且命令未通过管道传输（例如： Atlas command > out.zip）时，需要使用此标志 |
--pretty | false | 指示响应正文是否应采用 prettyprint 格式的标记。 | |
--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。 |