ANNOUNCEMENT: Voyage AI joins MongoDB to power more accurate and trustworthy AI applications on Atlas.
Learn more
Menu Docs

Rotate the KMIP Master Key ID

Observação

Grupos e projetos são termos sinônimos. Seu {PROJECT-ID} é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. Esta página usa o termo grupo, que é mais familiar, ao se referir a descrições. O endpoint permanece conforme indicado no documento.

Importante

Os backups de bancos de dados MongoDB usam a configuração de criptografia do sistema.

Use the PUT HTTP method with the following endpoint to rotate the KMIP master key. Issue one PUT request for each shard and another PUT request for the config server replica set.

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

PUT /groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/encryptionKey
Nome
Tipo
necessidade
Descrição

{GROUP-ID}

string

Obrigatório

Unique identifier of the project to which the encryption key belongs.

{CLUSTER-ID}

string

Obrigatório

Unique identifier of the cluster to which the encryption keys belongs.

Os seguintes parâmetros de query são opcionais:

Nome
Tipo
necessidade
Descrição
Default

pretty

booleano

Opcional

Sinalizador que indica se o corpo da resposta deve estar em um formato prettyprint.

false

envelope

booleano

Opcional

Sinalizador que indica se deseja ou não envolver a resposta em um envelope.

Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query.

Para endpoints que retornam um resultado, o corpo da resposta inclui:

Nome
Descrição

status

Código de resposta HTTP

content

Corpo de resposta esperado

false

Este endpoint não usa parâmetros do corpo da solicitação HTTP.

Nome
Tipo
Descrição

groupId

string

Unique identifier of the project to which the encryption key belongs.

clusterId

string

Unique identifier of the cluster to which the encryption keys belongs.

encryptionKeyUUID

string

Unique identifier of the KMIP master key. This key encrypts and restores the head databases for an encrypted backup.

O FCV 4.2 e posterior utilizam cursores de backup em vez de head databases. Para obter mais informações, consulte o Serviço Backup Daemon .

Para obter mais informações sobre criptografia de backup para FCV 4.2 ou posterior, consulte Snapshots de backup criptografados.

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}

Este endpoint retorna um objeto JSON vazio.