Obter todas as configurações do Backup Daemon
Nesta página
Recupera as configurações de todos os daemons de backup.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource
GET /daemon/configs
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 Para endpoints que retornam uma lista de resultados, o objeto | 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 incorporado results . |
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 é um daemon de backup .
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 odiretó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
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?pretty=true'
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
{ "links" : [ { "href" : "http://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/daemon/configs?pretty=true&pageNum=1&itemsPerPage=100", "rel" : "self" } ], "results" : [ { "assignmentEnabled" : true, "backupJobsEnabled" : false, "configured" : true, "garbageCollectionEnabled" : true, "headDiskType" : "SSD", "id" : "{DAEMON-CONFIG}", "labels" : [ "l1", "l2" ], "links" : [ { "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/daemon/configs/{DAEMON-CONFIG}", "rel" : "self" }], "machine" : { "headRootDirectory" : "/data/backup/", "machine" : "localhost" }, "numWorkers" : 50, "resourceUsageEnabled" : true, "restoreJobsEnabled" : false, "restoreQueryableJobsEnabled" : true } ], "totalCount" : 1 }