Docs 菜单
Docs 主页
/
MongoDB Ops Manager
/ / / /

轮换 KMIP 主密钥 ID

在此页面上

  • Resource
  • 请求参数
  • 请求路径参数
  • 请求查询参数
  • 请求正文参数
  • 响应
  • 请求示例
  • 响应示例
  • 响应标头
  • 响应体

注意

注意:群组和项目是同义词。您的 {PROJECT-ID} 与您的项目 ID 相同。对于现有群组,群组/项目 ID 保持不变。当引用说明时,此页面将使用“群组”这个更为人熟知的术语。端点仍如文档中所述。

重要

此端点适用于运行FCV 4.0或更早版本的MongoDB数据库的备份。 运行FCV 4.2或更高版本的MongoDB数据库的备份使用部署的加密设置。

通过以下端点使用PUT HTTP方法来轮换KMIP主密钥。 为每个分片发出一个PUT请求,为配置服务器副本集发出另一个PUT请求。

基本 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

PUT /groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/encryptionKey
名称
类型
必要性
说明
{GROUP-ID}
字符串
必需
加密密钥所属项目的唯一标识符。
{CLUSTER-ID}
字符串
必需
加密密钥所属集群的唯一标识符。

以下查询参数为可选参数:

名称
类型
必要性
说明
默认
pretty
布尔
Optional
指示响应正文是否应采用 Prettyprint 的标志 格式。
false
envelope
布尔
Optional

指示是否将响应包装在信封中的标志。

某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题,可在查询中设置 envelope=true

对于返回一个结果的端点,响应体包括:

名称
说明
状态
HTTP 响应代码
envelope
预期响应正文
false

此端点不使用 HTTP 请求正文参数。

名称
类型
说明
groupId
字符串
加密密钥所属项目的唯一标识符。
clusterId
字符串
加密密钥所属集群的唯一标识符。
encryptionKeyUUID
字符串

KMIP主密钥的唯一标识符。 此密钥可对加密备份的头部数据库进行加密和恢复。

FCV 4.2 ,然后使用备份游标而不是头部数据库。 有关详细信息,请参阅备份守护程序服务。

有关 FCV 4.2 或更高版本的备份加密的更多信息,请参阅加密备份快照。

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--include \
--request PUT "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/encryptionKey"
HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 201 Created
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

此端点返回一个空的JSON对象。

后退

检索 KMIP 主密钥 ID