Criar uma configuração do Backup Daemon
Nesta página
Configura um novoDaemon de Backup .
Observação
Use esse endpoint ao configurar um Backup Daemon pela primeira vez. Certifique-se de que o processo do Backup Daemon esteja em execução antes de configurá-lo usando esse endpoint.
Se você já configurou o Backup Daemon, atualize-o usando o endpoint Update One Backup Daemon Configuration .
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource
PUT /daemon/configs/{MACHINE}
Parâmetros do caminho da solicitação
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. |
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:
| false |
Parâmetros do corpo da solicitação
Nome | Tipo | necessidade | Descrição |
|---|---|---|---|
assignmentEnabled | booleano | Opcional | Sinalizador que indica se esse Backup Daemon pode receber tarefas de backup. |
backupJobsEnabled | booleano | Opcional | Sinalizador que indica se este Backup Daemon pode ser usado para fazer backup de bancos de dados. |
configured | booleano | Opcional | Sinalizador que indica se este Backup Daemon está pronto para uso. |
garbageCollectionEnabled | booleano | Opcional | Sinalizador que indica se este Backup Daemon tem coleta de lixo definida. |
headDiskType | string | Opcional | Tipo de disco usado para armazenar o diretório principal. Os valores aceitos para esta opção são:
|
id | string | Obrigatório | Identificador único deste Backup Daemon. |
labels | array de strings | Opcional | Array de tags para gerenciar quais tarefas de backup o MongoDB Ops Manager pode atribuir a quais Backup Daemons. A definição dessas tags limita as tarefas de backup que esse Backup Daemon pode processar. Se omitido, este Backup Daemon só pode processar tarefas de backup para projetos que não usam rótulos para filtrar suas tarefas. |
machine | objeto | Obrigatório | Faça o backup do host do Daemon e de seus diretórios principais. |
machine.headRootDirectory | string | Opcional | Caminho relativo à raiz do diretório principal neste host do Backup Daemon . Este diretório deve terminar com uma barra ( /). Se você omitir a barra, o Backup Daemon gerará um erro de Exceção Java . |
machine.machine | string | Obrigatório | Nome do host ou endereço IP do host do Backup Daemon . |
numWorkers | número | Opcional | Número de processos de trabalho que podem executar tarefas (ou seja, backup, restore ou limpeza) para o Backup Daemon. |
resourceUsageEnabled | booleano | Opcional | Sinalizador que indica se este Backup Daemon tem seu uso de recursos monitorado. |
restoreQueryableJobsEnabled | booleano | Opcional | Sinalizador que indica se este Backup Daemon pode realizar restaurações consultáveis. |
Resposta
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:
|
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 |
machine | objeto | Faça o backup do host do Daemon e de seus diretórios principais. |
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. |
Exemplo de solicitação
1 curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ 2 --header 'Accept: application/json' \ 3 --header 'Content-Type: application/json' \ 4 --include \ 5 --request PUT 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/daemon/configs/{MACHINE}/?pretty=true' \ 6 --data '{ 7 "assignmentEnabled" : true, 8 "backupJobsEnabled" : false, 9 "configured" : true, 10 "garbageCollectionEnabled" : true, 11 "headDiskType" : "SSD", 12 "id" : "{BACKUP-DAEMON-ID}", 13 "labels" : [ "l1", "l2" ], 14 "machine" : { 15 "headRootDirectory" : "/data/backup/", 16 "machine" : "localhost" 17 }, 18 "numWorkers" : 50, 19 "resourceUsageEnabled" : true, 20 "restoreQueryableJobsEnabled" : true 21 }'
Exemplo de resposta
Cabeçalho de resposta
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
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 "assignmentEnabled" : true, 3 "backupJobsEnabled" : false, 4 "configured" : true, 5 "garbageCollectionEnabled" : true, 6 "headDiskType" : "SSD", 7 "id" : "{BACKUP-DAEMON-ID}", 8 "labels" : [ "l1", "l2" ], 9 "links" : [ { 10 "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/daemon/configs/{MACHINE}/<machine.headRootDirectory>", 11 "rel" : "self" 12 }], 13 "machine" : { 14 "headRootDirectory" : "/data/backup/", 15 "machine" : "localhost" 16 }, 17 "numWorkers" : 50, 18 "resourceUsageEnabled" : true, 19 "restoreQueryableJobsEnabled" : true 20 }