Menu Docs
Página inicial do Docs
/
MongoDB Ops Manager
/
API
/
Recursos
/
Backup e restauração
/
Snapshots

Criar um snapshot on-demand

Nesta página

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

Resource

POST /groups/{groupId}/clusters/{clusterId}/snapshots/onDemandSnapshot

Permissões necessárias

Você deve ter o Global Backup Admin para tirar um snapshot sob demanda.

Parâmetros da solicitação

Parâmetros do caminho da solicitação

Nome
Tipo
Descrição

ID do grupo

string

Identificador único do seu projeto a partir das configurações do projeto.

ID DE CLUSTER

string

Identificador exclusivo do cluster que o snapshot do representa.

Solicitar parâmetros de query

Nome
Tipo
necessidade
Descrição
Exemplo

retentionDays

número

Obrigatório

Inteiro que indica o número de dias em que o snapshot on-demand será retido. Deve ser maior que 0.

15

envelope

booleano

Opcional

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

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

Para endpoints que retornam uma lista de resultados, o objeto results é um envelope. O Ops Manager adiciona o campo status ao corpo da resposta.

false

Parâmetros do corpo da solicitação

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

Resposta

Exemplo de solicitação

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --include \
 --request POST "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{groupId}/clusters/{clusterId}/snapshots/onDemandSnapshot"

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

{
   "clusterName": "myCluster",
   "description": "On demand snapshot request complete .",
   "timestamp": {
       "increment": 1,
       "time": 1719518976,
       "date": "2024-06-27T20:09:36Z"
   }
}

Voltar

Remover um

Próximo

Obter todos (servidor de configuração)