Recuperar o ID da chave mestra KMIP

Nesta página

Resource

Parâmetros da solicitação
Parâmetros do caminho da solicitação
Solicitar parâmetros de query
Parâmetros do corpo da solicitação
Resposta
Exemplo de solicitação
Exemplo de resposta
Cabeçalho de resposta
Corpo de resposta

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 grupo de termos mais conhecido ao se referir às descrições. O ponto final permanece conforme indicado no documento.

Importante

Os backups de bancos de dados MongoDB usam aconfiguração de criptografia dosistema .

Use o métodoHTTP GET com o mesmo endpoint para recuperar o ID da chave mestra KMIP atual.

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

Resource

GET /groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/encryptionKey

Parâmetros da solicitação

Parâmetros do caminho da solicitação

Nome	Tipo	necessidade	Descrição
`{GROUP-ID}`	string	Obrigatório	Identificador único do projeto ao qual pertence a chave de criptografia.
`{CLUSTER-ID}`	string	Obrigatório	Identificador único do cluster ao qual pertencem as chaves de criptografia.

Solicitar parâmetros de query

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

Nome

Tipo

necessidade

Descrição

Default

pretty

booleano

Opcional

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

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

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
`groupId`	string	Identificador único do projeto ao qual pertence a chave de criptografia.
`clusterId`	string	Identificador único do cluster ao qual pertencem as chaves de criptografia.
`encryptionKeyUUID`	string	Identificador único da chave mestra KMIP . Essa chave criptografa e restaura o banco de dados principal para um backup criptografado. FCV `4.2` e, posteriormente, use 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.

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

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 200 OK
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

{
  "clusterId" : "{CLUSTER-ID}",
  "groupId" : "{PROJECT-ID}",
  "encryptionKeyUUID": "1234-3456-4567-abcd-def0"
}

Voltar

Backup chave de criptografia

Girar o ID da chave mestra KMIP