Rotate the KMIP Master Key ID
Nesta página
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
Resource
PUT /groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/encryptionKey
Parâmetros da solicitação
Parâmetros do caminho da solicitação
Nome | Tipo | necessidade | Descrição |
---|---|---|---|
| string | Obrigatório | Unique identifier of the project to which the encryption key belongs. |
| string | Obrigatório | Unique identifier of the cluster to which the encryption keys belongs. |
Solicitar parâmetros de query
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. |
| ||||||
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:
|
|
Parâmetros do corpo da solicitação
Este endpoint não usa parâmetros do corpo da solicitação HTTP.
Resposta
Nome | Tipo | Descrição |
---|---|---|
| string | Unique identifier of the project to which the encryption key belongs. |
| string | Unique identifier of the cluster to which the encryption keys belongs. |
| string | Unique identifier of the KMIP master key. This key encrypts and restores the head databases for an encrypted backup. O FCV Para obter mais informações sobre criptografia de backup para FCV 4.2 ou posterior, consulte Snapshots de backup criptografados. |
Exemplo de solicitação
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"
Exemplo de resposta
Cabeçalho de resposta
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
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}
Corpo de resposta
Este endpoint retorna um objeto JSON vazio.