A sua instalação do Ops Manager gera uma chave de identidade: um par de chaves que a instalação usa para comprovar sua identidade ao se conectar ao MongoDB. Se alguém de fora da sua organização obtiver a chave privada, ela estará comprometida e essa pessoa poderá se passar pela sua instalação.
Use este endpoint para rotacionar a chave de identidade. A rotação substitui a chave por um novo par de chaves. Se a rotação falhar, o Ops Manager não aplica nenhuma alteração e a chave atual permanece ativa. A resposta sempre contém o resultado da rotação.
Importante
Your Ops Manager installation must be able to connect to MongoDB to rotate the key. If it can't, the endpoint returns the HTTP status 502 with the outcome UNREACHABLE or EA_UNAVAILABLE.
Funções obrigatórias
To access this resource, your API key must have the Global Owner role. The Global Owner role is the highest role in Ops Manager. Only users with this role can view and manage license keys.
Solicitar
Send a POST request to start the rotation.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
POST /admin/artifacts/identity/rotateParâmetros do caminho da solicitação
Este endpoint não usa parâmetros de caminho de solicitação HTTP.
Solicitar parâmetros de query
Este endpoint aceita os seguintes parâmetros de consulta:
Nome | Tipo | necessidade | Descrição | Default |
|---|---|---|---|---|
pretty | booleano | Opcional | Sinalizador que indica se o corpo da resposta está em um formato pretty-print. |
|
envelope | booleano | Opcional | Sinalizador que indica se deve 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
A resposta contém os seguintes campos:
Campo | Tipo | Descrição |
|---|---|---|
| string | Resultado da rotação. O Ops Manager retorna um dos valores na tabela a seguir. |
| string | Sentence that describes why Ops Manager didn't apply the rotation. This field is |
A tabela a seguir lista cada resultado com seu status HTTP e mensagem:
Resultado | HTTP Status | mensagem |
|---|---|---|
| 200 | O Ops Manager não retorna nenhuma mensagem. |
| 502 | Não foi possível contatar o MongoDB para concluir a rotação. Nenhuma alteração foi aplicada — a chave atual permanece ativa. Tente novamente em breve. |
| 502 | O serviço MongoDB Enterprise Advanced está indisponível. Nenhuma alteração foi aplicada — a chave atual permanece ativa. Tente novamente em breve. |
| 409 | Ainda não existe uma identidade de inscrição para rotacionar — uma é criada na primeira instalação. |
| 409 | O MongoDB rejeitou a prova de posse da rotação. A chave atual permanece ativa. Entre em contato com a equipe da sua conta MongoDB. |
| 409 | A identidade de inscrição foi alterada simultaneamente. Nenhuma alteração foi aplicada — tente novamente em breve. |
| 409 | O MongoDB rejeitou a solicitação de rotação. A chave atual permanece ativa. |
Exemplo de solicitação
Use curl to send a POST request to the /admin/artifacts/identity/rotate endpoint:
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request POST \ "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/artifacts/identity/rotate?pretty=true"Exemplo de resposta
Os exemplos a seguir mostram os cabeçalhos e o corpo da resposta de uma solicitação bem-sucedida.
Cabeçalho de resposta
Os cabeçalhos a seguir mostram uma resposta não autorizada e uma resposta bem-sucedida:
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}Corpo de resposta
O exemplo a seguir mostra o corpo da resposta:
{ "outcome": "ROTATED", "message": null}