Menu Docs
Página inicial do Docs
/
MongoDB Ops Manager
/ / / /

Remover um snapshot de um cluster

Nesta página

  • Resource
  • Permissões necessárias
  • 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

Todas as solicitações para esse endpoint devem ser originadas de um IP endereço na MongoDB Ops Manager API lista de acesso à do usuário do . Para obter a documentação completa sobre a configuração de listas de acesso à API, consulte Exigir uma lista de acesso à API para sua organização.

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

DELETE /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/snapshots/{SNAPSHOT-ID}

Você deve ter a role Global Backup Admin ou Global Owner para excluir um snapshot que esteja dentro da janela de restauração ponto-in-time.

Nome
Tipo
Descrição

ID do projeto

string

Identificador exclusivo doprojeto que possui o snapshot.

ID DE CLUSTER

string

Identificador exclusivo do cluster que o snapshot representa.

SNAPSHOT-ID

string

Identificador exclusivo do snapshot.

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

Nome
Tipo
necessidade
Descrição
Default

pretty

booleano

Opcional

false

envelope

booleano

Opcional

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

Alguns clientes da 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

envelope

Corpo de resposta esperado

false

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

Este endpoint não tem elementos de resposta.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
--include \
--request DELETE "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/snapshots/{SNAPSHOT-ID}"

Este endpoint não retorna um corpo de resposta.

Voltar

Alterar expiração