Menu Docs
Página inicial do Docs
/
MongoDB Ops Manager
/
API
/
Recursos da API de administração do Ops Manager
/
Administração de backup
/
Configurações da tarefa de backup do projeto

Obter todas as configurações das tarefas de backup do projeto

Nesta página

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

Recupera as configurações de todas as tarefas de backup do projeto.

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

Recurso

GET /groups

Parâmetros do caminho da solicitação

Este endpoint não usa parâmetros de caminho de solicitação HTTP.

Solicitar parâmetros de query

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

Nome
Tipo
necessidade
Descrição
default
pageNum
número
Opcional
Um inteiro baseado que retorna uma subseção de resultados.
1
itemsPerPage
número
Opcional
Número de itens a serem devolvidos por página, até um máximo de 500.
100
pretty
booleano
Opcional
Sinalizador que indica 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 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
backupJobsEnabledOnly
booleano
Opcional
Sinalizador que indica se os daemon não habilitados para reconhecimento de data center devem ser excluídos da resposta. Defina isso como false para incluir configurações de daemon com o sinalizador backupJobsEnabled definido como false.
true

Parâmetros do corpo da solicitação

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

Resposta

documento de resposta

O documento JSON de resposta inclui uma array de objetos result , uma array de objetos link e uma contagem do número total de objetos result recuperados.

Nome
Tipo
Descrição
results
array
A array inclui um objeto para cada item detalhado na seção Documento incorporadoresults .
links
array
A array inclui um ou mais links para sub-recursos e/ou recursos relacionados. As relações entre URLs são explicadas na Especificação de links da web.
totalCount
número
Contagem de números inteiros do número total de itens no conjunto de resultados. Pode ser maior que o número de objetos na array results se todo o conjunto de resultados for paginado.

results documento incorporado

Cada resultado são as tarefas de backup de um projeto.

Nome
Tipo
Descrição
daemonFilter
array de objetos
Uma array de pares de hosts do Backup Daemon e seusdiretórios head para os quais as tarefas de backup deste projeto são limitadas.
daemonFilter.headRootDirectory
string
O caminho relativo à raiz do diretório principal neste host do Backup Daemon .
daemonFilter.machine
string
O endereço de host para um host do Backup Daemon .
id
string
O identificador único que representa este projeto e sua configuração de tarefa de backup.
kmipClientCertPassword
string
A senha que criptografa o certificado do cliente KMIP .
kmipClientCertPath
string
O caminho para o diretório no host do Backup Daemon que armazena o certificado do cliente KMIP .
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.

filtro de etiqueta
array de strings
Uma array de tags que limita quais Backup Daemons e armazenamentos de snapshots podem processar tarefas de backup para esse projeto.
oplogStoreFilter
Array de objetos
Uma array de identificadores únicos representando armazenamentos deoplog que podem ser usados com as tarefas de backup deste projeto.
oplogStoreFilter.id
string
Identificador único que representa um armazenamento de oplog que pode ser usado com as tarefas de backup deste projeto.
oplogStoreFilter.type
string
Tipo de armazenamento de oplog a ser usado. Esse valor é sempre oplogStore.
snapshotStoreFilter
Array de objetos
Array de identificadores únicos representando armazenamentos de snapshots específicos e seus tipos que podem ser usados com as tarefas de backup deste projeto. Se omitido, todos os armazenamentos de snapshots disponíveis serão usados.
snapshotStoreFilter.id
string
O identificador exclusivo que representa armazenamentos de snapshots específicos que podem ser usados com as tarefas de backup deste projeto.
snapshotStoreFilter.type
string

O tipo do armazenamento de snapshots específico fornecido como snapshotStoreFilter.id.

Os valores aceitos para esta opção são:

  • s3blockstore

  • blockstore

  • fileSystemStore

syncStoreFilter
array de strings
Uma array de filtros de armazenamento de sincronização que podem ser usados com as tarefas de backup deste projeto. Se omitido, todos os armazenamentos de sincronização disponíveis serão usados.

Exemplo de solicitação

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --header 'Accept: application/json' \
 --include \
 --request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/groups?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

{
  "links" : [ {
    "href" : "http://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/groups?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ {
    "daemonFilter" : [ {
      "headRootDirectory" : "/data/backup",
      "machine" : "http://backup.example.com"
    } ],
    "id" : "{PROJECT-ID}",
    "kmipClientCertPassword" : "P4$$w0rD",
    "kmipClientCertPath" : "/certs/kmip",
    "labelFilter" : [ "label1", "label2" ],
    "links" : [ {
      "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/groups/{PROJECT-ID}",
      "rel" : "self"
    }, {
      "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/groups/{PROJECT-ID}",
      "rel" : "http://mms.mongodb.com/group"
    } ],
    "oplogStoreFilter" : [ {
      "id" : "oplog1",
      "type" : "oplogStore"
    } ],
    "snapshotStoreFilter" : [ {
      "id" : "sPid",
      "type" : "s3blockstore"
    } ],
    "syncStoreFilter" : [ "s1", "s2" ]
  } ],
  "totalCount" : 1
}

Voltar

Obter uma configuração de tarefas de backup de projeto por ID