Crear una configuración de demonio de respaldo

Esta versión de la documentación está archivada y ya no se admite. Ver la Documentación actual para aprender cómo actualizar su versión de MongoDB Ops Manager.

Configura un nuevo demonio de copia de seguridad.

Nota

Utilice este punto final al configurar un demonio de copia de seguridad por primera vez. Asegúrese de que el proceso del demonio de copia de seguridad esté en ejecución antes de configurarlo con este punto final.

Si ya ha configurado el Backup Daemon, actualícelo mediante el Actualizar un punto final de configuración del demonio de copia de seguridad.

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

Resource

PUT /daemon/configs/{MACHINE}

Parámetros de la ruta de solicitud

Nombre	Tipo	Necesidad	Descripción
MÁQUINA	string	Requerido	Nombre de host o dirección IP de la máquina que sirve al Daemon de respaldo.

Parámetros de consulta de solicitud

Los siguientes parámetros de consulta son opcionales:

Nombre

Tipo

Necesidad

Descripción

predeterminado

bonita

booleano

Opcional

Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint formato.

false

envolvente

booleano

Opcional

Bandera que indica si se debe o no envolver la respuesta en un sobre.

Algunos Los clientes de laAPI no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta.

Para los puntos finales que devuelven un resultado, el cuerpo de la respuesta incluye:

Nombre	Descripción
Estado	Código de respuestaHTTP
envolvente	Cuerpo de respuesta esperado

false

Parámetros del cuerpo de la solicitud

Nombre	Tipo	Necesidad	Descripción
`assignmentEnabled`	booleano	Opcional	Bandera que indica si a este Daemon de respaldo se le pueden asignar trabajos de respaldo.
`backupJobsEnabled`	booleano	Opcional	Bandera que indica si este demonio de respaldo se puede utilizar para realizar copias de seguridad de bases de datos.
`configured`	booleano	Opcional	Bandera que indica si este Daemon de respaldo está listo para usarse.
`garbageCollectionEnabled`	booleano	Opcional	Indicador que muestra si este daemon de copias de seguridad tiene configurada la recolección de basura.
`headDiskType`	string	Opcional	Tipo de disco utilizado para almacenar el directorio principal. Los valores aceptados para esta opción son: `HDD` `SSD`
`id`	string	Requerido	Identificador único de este demonio de copia de seguridad.
`labels`	matriz de cadenas	Opcional	Matriz de etiquetas para administrar qué trabajos de respaldo puede asignar Ops Manager a qué Daemons de respaldo. Configurar estas etiquetas limita los trabajos de copia de seguridad que este Daemon de Copia de Seguridad puede procesar. Si se omite, este Daemon de Copia de Seguridad solo puede procesar trabajos de copia de seguridad de proyectos que no usan etiquetas para filtrar sus trabajos.
`machine`	Objeto	Requerido	Realizar una copia de seguridad del host Daemon y de sus directorios principales.
`machine.headRootDirectory`	string	Opcional	Ruta relativa a la raíz del directorio principal en este host del Daemon de Backup. Este directorio debe terminar con una barra diagonal`/` (). Si se omite la barra diagonal, el Daemon de Backup genera un error de excepción de Java.
`machine.machine`	string	Requerido	Nombre de host o dirección IP del host del Backup Daemon.
`numWorkers`	Número	Opcional	Número de procesos de trabajo que pueden realizar tareas (es decir, realizar copias de seguridad, restaurar o limpiar) para el demonio de copia de seguridad.
`resourceUsageEnabled`	booleano	Opcional	Bandera que indica si se monitorea el uso de recursos de este Daemon de respaldo.
`restoreQueryableJobsEnabled`	booleano	Opcional	Bandera que indica si este demonio de copia de seguridadpuede realizar restauraciones consultables.

Respuesta

Nombre	Tipo	Descripción
`assignmentEnabled`	booleano	Bandera que indica si a este Daemon de respaldo se le pueden asignar trabajos de respaldo.
`backupJobsEnabled`	booleano	Bandera que indica si este demonio de respaldo se puede utilizar para realizar copias de seguridad de bases de datos.
`configured`	booleano	Bandera que indica si este Daemon de respaldo está listo para usarse.
`garbageCollectionEnabled`	booleano	Indicador que muestra si este daemon de copias de seguridad tiene configurada la recolección de basura.
`headDiskType`	string	Tipo de disco utilizado para almacenar el directorio principal. Los valores aceptados para esta opción son: `HDD` `SSD`
`id`	string	Identificador único de este demonio de copia de seguridad.
`labels`	matriz de cadenas	Matriz de etiquetas para administrar qué trabajos de respaldo puede asignar Ops Manager a qué Daemons de respaldo.
`links`	matriz de objetos	Uno o más enlaces a subrecursos o recursos relacionados. Todas las `links` matrices en las respuestas incluyen al menos un enlace `self` llamado. Las relaciones entre las URLse explican en la Especificación de Enlaces Web.
`machine`	Objeto	Realizar una copia de seguridad del host Daemon y de sus directorios principales.
`machine.headRootDirectory`	string	Ruta relativa a la raíz del directorio principal en este host de Backup Daemon.
`machine.machine`	string	Nombre de host o dirección IP del host del Backup Daemon.
`numWorkers`	Número	Número de procesos de trabajo que pueden realizar tareas (es decir, realizar copias de seguridad, restaurar o limpiar) para el demonio de copia de seguridad.
`resourceUsageEnabled`	booleano	Bandera que indica si se monitorea el uso de recursos de este Daemon de respaldo.
`restoreQueryableJobsEnabled`	booleano	Bandera que indica si este demonio de copia de seguridadpuede realizar restauraciones consultables.

Ejemplo de solicitud

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

Ejemplo de respuesta

Encabezado de respuesta

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}

Cuerpo de respuesta

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 }

Volver

Obtener todo

Update

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