Menu Docs
Página inicial do Docs
/
MongoDB Ops Manager
/
API
/
Recursos da API de administração do Ops Manager
/
Backup e restauração
/
Configurações de backup

Obtenha uma configuração de backup de um projeto

Nesta página

  • Recurso
  • 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.

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

Recurso

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

Parâmetros da solicitação

Parâmetros do caminho da solicitação

Parâmetro
Tipo
necessidade
Descrição
ID do projeto
string
Obrigatório
Sequência exclusiva de 24 dígitos hexadecimais que identifica o projeto que contém o cluster com a configuração de backup que você deseja encontrar.
ID DE CLUSTER
string
Obrigatório
Sequência exclusiva de 24 dígitos hexadecimais que identifica o cluster cuja configuração de backup você deseja encontrar.

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

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
Membros disponíveis
array de strings
Lista de membros do cluster disponíveis para backup. Aparece apenas para solicitações de membros.
clusterId
string
String exclusiva de 24 dígitos hexadecimais que identifica o cluster a ser configurado para backup.
encryptionEnabled
booleano

Sinalizador que indica se a criptografia está habilitada para a configuração de backup. Você deve incluir o campo syncSource ao habilitar a criptografia para uma configuração de backup. Para backups existentes em um projeto, ativar a criptografia requer uma sincronização inicial para recriar os head databases dos backups.

Observação

O FCV FCV 4.2 e posterior utilizam cursores de backup em vez de head databases. Para obter mais informações, consulte Serviço Daemon de Backup.

Para obter mais informações sobre criptografia de backup para FCV 4.2 ou posterior, consulte Snapshots de backup criptografados.

excludedNamespaces
array de strings

Lista de nomes de reconhecimento de data center e nomes de collection para omitir do backup. Cada string é um namespace na forma de {database} ou {database}.{collection}. Se este campo estiver presente, o campo includedNamespaces não poderá estar presente.

Você deve enviar a nova lista completa de namespaces excluídos, incluindo aqueles que já foram listados.

Se a nova lista remover qualquer namespace da lista anterior, você também deverá definir o campo syncSource , pois a remoção de um namespace excluído exige uma ressincronização completa. Sem o campo syncSource , a solicitação falhará.

Se a nova lista for apenas adicionada à lista anterior, você não precisará definir syncSource.

groupId
string
String única de 24 dígitos hexadecimais que identifica o projeto que possui esta configuração de backup.
includeNamespaces
array de strings

Lista de nomes de reconhecimento de data center e nomes de collection a serem incluídos no backup. Cada string é um namespace na forma de {database} ou {database}.{collection}. Qualquer namespace não listado nesta array não será copiado. Se este campo estiver presente, o campo excludedNamespaces não poderá estar presente.

Você deve enviar a nova lista completa de namespaces incluídos, inclusive os que já foram listados.

Se a nova lista adicionar quaisquer namespaces à lista anterior, você também deverá definir o campo syncSource , pois a adição de um namespace incluído exige uma ressincronização completa. Sem o campo syncSource , a solicitação falhará.

Se a nova lista remover apenas namespaces da lista anterior, você não precisará definir syncSource.

links
array de objetos

Um ou mais links para sub-recursos e/ou recursos relacionados. Todas as arrays links nas respostas incluem pelo menos um link chamado self. Os relacionamentos entre URLs são explicados na Especificação de links da web.

primaryMember
string
Membro do cluster designado manualmente como o membro preferencial para backup. Aparece somente para solicitações de membro quando o membro preferencial é definido com a UI ou API.
sslEnabled
booleano
Sinalizador que identifica se o TLS está habilitado para o reconhecimento de data center de origem de sincronização.
statusName
string

Status atual (ou desejado) da configuração de backup. Os valores possíveis são:

  • INACTIVE

  • PROVISIONING

  • STARTED

  • STOPPED

  • TERMINATING

storageEngineName
string

storage engine usado para o backup. Os valores possíveis são:

  • MEMORY_MAPPED

  • WIRED_TIGER

Exemplo de solicitação

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}"

Quando cada snapshot é iniciado, o Ops Manager seleciona um membro do conjunto de réplicas para executar o snapshot. Esse membro selecionado automaticamente deve ter o menor impacto no desempenho no conjunto de réplicas. Você pode substituir a seleção padrão.

Importante

Use default selection sempre que possível. Essa opção garante a disponibilidade do backup.

A seguinte solicitação retorna os membros disponíveis.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/availableMembers?pretty=true"

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

1{
2  "clusterId" : "{CLUSTER-ID}",
3  "encryptionEnabled" : false,
4  "excludedNamespaces" : [ ],
5  "groupId" : "{PROJECT-ID}",
6  "includedNamespaces" : [ ],
7  "links" : [ ],
8  "sslEnabled" : false,
9  "statusName" : "STARTED",
10  "storageEngineName" : "WIRED_TIGER"
11}

Quando cada snapshot é iniciado, o Ops Manager seleciona um membro do conjunto de réplicas para executar o snapshot. Esse membro selecionado automaticamente deve ter o menor impacto no desempenho no conjunto de réplicas. Você pode substituir a seleção padrão.

Importante

Use default selection sempre que possível. Essa opção garante a disponibilidade do backup.

A seguinte resposta inclui os membros disponíveis e o membro preferencial designado. Se um membro preferencial não estiver definido, ele será excluído da resposta.

1{
2  "availableMembers" : [ "{HOSTNAME1}:{PORT1}", "{HOSTNAME2}:{PORT2}", "{HOSTNAME3}:{PORT3}"],
3  "clusterId" : "{CLUSTER-ID}",
4  "encryptionEnabled" : false,
5  "excludedNamespaces" : [ ],
6   "groupId" : "{PROJECT-ID}",
7   "includedNamespaces" : [ ],
8   "links" : [ ],
9   "sslEnabled" : false,
10   "statusName" : "STARTED",
11   "storageEngineName" : "WIRED_TIGER",
12   "preferredMember" : "{HOSTNAME1}:{PORT1}"
13 }

Voltar

Obter todas as configurações de backup de um projeto