实验性:使用您通过云提供商管理的密钥更新静态加密配置。
即使您不使用自己的密钥管理, MongoDB Cloud 也会加密所有存储。此资源要求请求的API密钥具有项目所有者角色。此功能不适用于 M0 免费集群、M2、M5 或无服务器集群。在您为MongoDB Cloud项目配置至少一项使用客户数密钥管理提供商的静态加密后,项目所有者可以为需要加密的每个MongoDB Cloud集群启用使用客户数密钥管理的静态加密。使用客户数密钥管理提供商的静态加密不必与集群云服务提供商匹配。MongoDB Cloud 不会自动轮换用户管理的加密密钥。使用客户数密钥管理提供商的文档和密钥轮换最佳实践指导,遵循您首选的静态加密。当您在MongoDB Cloud项目中使用您的密钥管理配置使用客户数密钥管理的静态加密时, MongoDB Cloud 会自动创建 90 天的密钥轮换警报。无论您是否使用自己的密钥管理, MongoDB Cloud 都会加密所有存储。此命令正在调用 OperationID 为“updateEncryptionAtRest”的端点。有关标志、文件格式和示例的更多信息,请参阅:https://www.mongodb.com/zh-cn/docs/atlas/reference/api-resources-spec/v2/#标签/Encryption-at-Rest-using-Customer-Key-Management/operation/updateEncryptionAtRest
语法
atlas api encryptionAtRestUsingCustomerKeyManagement updateEncryptionAtRest [options]
选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
--envelope | false | 标志,指示应用程序是否将响应包装在信封JSON对象中 | |
--file | 字符串 | false | 包含API请求内容的文件的路径 |
--groupId | 字符串 | true | 用于标识项目的唯一 24-十六进制数字字符串 |
-h,--help | false | updateEncryptionAtRest 帮助 | |
--output | 字符串 | false | 首选API格式,可以是 ["JSON", go-template] 此值默认为 "JSON"。 |
--output-file | 字符串 | false | 要将API输出写入其中的文件。 当端点的输出为二进制(例如:gzip)且命令未通过管道传输(例如: Atlas command > out.zip)时,需要使用此标志 |
--pretty | false | 标志,指示响应正文是否应采用美观打印格式 | |
--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。 |