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

Obter uma configuração do Backup Daemon por ID

Nesta página

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

Recupera a configuração de um Backup Daemon.

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

GET /daemon/configs/{MACHINE}/{HEAD-ROOT-DIRECTORY}
Nome
Tipo
necessidade
Descrição
MÁQUÍA
string
Obrigatório
Nome do host ou endereço IP da máquina que atende ao Backup daemon.
HEAD-ROOT-DireCTORY
string
Opcional
CaminhoURL relativo à raiz do diretório principal neste host do Backup Daemon . Pode ser omitido se o Backup Daemon não tiver sido configurado.

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

Nome
Tipo
necessidade
Descrição
Default
pretty
booleano
Opcional
Sinalizador que indica se o corpo da resposta deve estar em um formato prettyprint.
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
content
Corpo de resposta esperado
false

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

Nome
Tipo
Descrição
assignmentEnabled
booleano
Sinalizador que indica se esse Backup Daemon pode receber tarefas de backup.
backupJobsEnabled
booleano
Sinalizador que indica se este Backup Daemon pode ser usado para fazer backup de bancos de dados.
configured
booleano
Sinalizador que indica se este Backup Daemon está pronto para uso.
garbageCollectionEnabled
booleano
Sinalizador que indica se este Backup Daemon tem coleta de lixo definida.
headDiskType
string

Tipo de disco usado para armazenar o diretório principal.

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

  • HDD

  • SSD

id
string
Identificador único deste Backup Daemon.
labels
array de strings
Array de tags para gerenciar quais tarefas de backup o MongoDB Ops Manager pode atribuir a quais Backup Daemons.
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.

machine
objeto
machine.headRootDirectory
string
Caminho relativo à raiz do diretório principal neste host do Backup Daemon .
machine.machine
string
Nome do host ou endereço IP do host do Backup Daemon .
numWorkers
número
Número de processos de trabalho que podem executar tarefas (ou seja, backup, restore ou limpeza) para o Backup Daemon.
resourceUsageEnabled
booleano
Sinalizador que indica se este Backup Daemon tem seu uso de recursos monitorado.
restoreQueryableJobsEnabled
booleano
Sinalizador que indica se este Backup Daemon pode realizar restaurações consultáveis.
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
--header 'Accept: application/json' \
--include \
--request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/daemon/configs/{MACHINE}/{HEAD-ROOT-DIRECTORY}?pretty=true'
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}
{
"assignmentEnabled" : true,
"backupJobsEnabled" : false,
"configured" : true,
"garbageCollectionEnabled" : true,
"headDiskType" : "SSD",
"id" : "5991a422ad5df350005dd062",
"labels" : [ "l1", "l2" ],
"links" : [ {
"href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/daemon/configs/{MACHINE}/{HEAD-ROOT-DIRECTORY}",
"rel" : "self"
}],
"machine" : {
"headRootDirectory" : "/data/backup/",
"machine" : "localhost"
},
"numWorkers" : 50,
"resourceUsageEnabled" : true,
"restoreJobsEnabled" : false,
"restoreQueryableJobsEnabled" : true
}

Voltar

Configurações do Backup Daemon