Docs Home

/ /

Proyecto tarea de copia de seguridad

Docs Home

/ /

Administración de copias de seguridad

Proyecto tarea de copia de seguridad

Docs Home

Gestión

Gerente de Operaciones

API

Recursos

Administración de copias de seguridad

Proyecto tarea de copia de seguridad

Obtener todas las configuraciones de trabajos de copia de seguridad del proyecto

Recupera las configuraciones de todas las tareas de copia de seguridad del Proyecto.

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

Resource

GET /groups

Parámetros de la ruta de solicitud

Este endpoint no utiliza parámetros de ruta de solicitud HTTP.

Parámetros de Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre	Tipo	Necesidad	Descripción	predeterminado
Num. de pág.	Número	Opcional	Entero basado en uno que devuelve una subsección de resultados.	`1`
elementosPorPágina	Número	Opcional	Número de elementos a devolver por página, hasta un máximo de 500.	`100`
bonito	booleano	Opcional	Bandera que indica si el cuerpo de la respuesta debe estar en una pretty-print formato.	`false`
envelope	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 endpoints que devuelven una lista de resultados, el objeto `results` es un sobre. Ops Manager agrega el campo `status` al cuerpo de la respuesta.	`false`
backupJobsEnabledOnly	booleano	Opcional	Indicador que indica si se deben excluir de la respuesta los daemons no habilitados para realizar copias de seguridad de bases de datos. Establezca este valor en `false` para incluir las configuraciones de daemon con el indicador `backupJobsEnabled` establecido en `false`.	`true`

Parámetros del cuerpo de la solicitud

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

Respuesta

Documento de respuesta

El documento JSON de respuesta incluye una matriz de result objetos, una matriz de link objetos y un recuento del número total de result objetos recuperados.

Nombre	Tipo	Descripción
`results`	arreglo	La matriz incluye un objeto para cada elemento detallado en el Sección `results` Documento incrustado.
`links`	arreglo	El arreglo incluye uno o más enlaces a subrecursos y/o recursos relacionados. Las relaciones entre URLse explican en la Especificación de enlace web.
`totalCount`	Número	Recuento entero del número total de elementos en el conjunto de resultados. Puede ser superior al número de objetos en el arreglo results si el conjunto de resultados completo está paginado.

`results` embeddedDocument

Cada resultado corresponde a las tareas de copia de seguridad de un proyecto.

Nombre	Tipo	Descripción
daemonFilter	objeto arreglo	Un arreglo de pares de hosts de daemon de copias de seguridad y sus directorios principales a los que se limitan las tareas de copia de seguridad de este Proyecto.
daemonFilter.headRootDirectory	string	La ruta relativa a la raíz del directorio principal en este host de Backup Daemon.
daemonFilter.máquina	string	La dirección del host de un host daemon de copias de seguridad.
ID	string	El identificador único que representa este proyecto y su configuración de trabajo de respaldo.
kmipClientCertPassword	string	La contraseña que cifra el certificado de cliente KMIP.
kmipClientCertPath	string	La ruta al directorio en el host de Backup Daemon que almacena el certificado de cliente KMIP.
enlaces	objeto arreglo	Uno o más enlaces a subrecursos y/o recursos relacionados. Todos los `links` arreglos en las respuestas incluyen al menos un enlace llamado `self`. Las relaciones entre URLs se explican en la Especificación de Enlaces Web.
filtro de etiquetas	Arreglo de cadenas	Una matriz de etiquetas que limita qué demonios de copias de seguridad y almacenamientos de snapshots pueden procesar tareas de copia de seguridad para este proyecto.
oplogStoreFilter	Arreglo de objetos	Un arreglo de identificadores únicos que representan almacenes de Oplog que se pueden usar con las tareas de copia de seguridad de este Proyecto.
oplogStoreFilter.id	string	Identificador único que representa un almacén de oplog que se puede utilizar con las tareas de copia de seguridad de este proyecto.
oplogStoreFilter.type	string	Tipo de almacenamiento de oplog que se va a utilizar. Este valor es siempre `oplogStore`.
snapshotStoreFilter	Arreglo de objetos	Arreglo de identificadores únicos que representan almacenamientos de snapshot específicos y sus tipos que pueden usarse con las tareas de copia de seguridad de este Proyecto. Si se omite, se utilizan todos los almacenamientos de snapshot disponibles.
snapshotStoreFilter.id	string	El identificador único que representa almacenamientos de snapshot específicos que pueden usarse con las tareas de copia de seguridad de este Proyecto.
snapshotStoreFilter.type	string	El tipo del almacenamiento de snapshot específico dada como `snapshotStoreFilter.id`. Los valores aceptados para esta opción son: `s3blockstore` `blockstore` `fileSystemStore`
syncStoreFilter	Arreglo de cadenas	Una matriz de filtros de almacenamiento de sincronización que se pueden usar con las tareas de copia de seguridad de este proyecto. Si se omite, se utilizan todos los almacenes de sincronización disponibles.

Solicitud de ejemplo

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'

Respuesta de ejemplo

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}

Respuesta del cuerpo

{
  "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
}

Volver

Obtener por ID

Update

Resource

Parámetros de la ruta de solicitud

Parámetros de Solicitud Query

Parámetros del cuerpo de la solicitud

Respuesta

Documento de respuesta

results embeddedDocument

Solicitud de ejemplo

Respuesta de ejemplo

Encabezado de respuesta

Respuesta del cuerpo

`results` embeddedDocument