Nombre	Tipo	Necesidad	Descripción	predeterminado
número de página	Número	Opcional	Entero basado en uno que devuelve una subsección de resultados.	`1`
artículos por página	Número	Opcional	Número de artículos a devolver por página, hasta un máximo de 500.	`100`
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 una lista de resultados, el objeto `results` es un sobre. Ops Manager añade el campo `status` al cuerpo de la respuesta.	`false`
trabajos de respaldo habilitados solamente	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 punto final no utiliza parámetros del cuerpo de la 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` de documento incrustado.
`links`	arreglo	La matriz incluye uno o más enlaces a subrecursos o recursos relacionados. Las relaciones entre las URLse explican en la Especificación de Enlaces Web.
`totalCount`	Número	Número entero del número total de elementos en el conjunto de resultados. Puede ser mayor que el número de objetos en la matriz results si todo el conjunto de resultados está paginado.

`results` Documento incrustado

Cada resultado son los trabajos de respaldo de un proyecto.

Nombre	Tipo	Descripción
daemonFilter	matriz de objetos	Una matriz de pares de hosts de Backup Daemon y sus directorios principales a los que están limitados los trabajos de respaldo 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 de host de un host de Backup Daemon.
ID.	string	El identificador único que representa este proyecto y su configuración de trabajo de respaldo.
Contraseña del certificado de cliente kmip	string	La contraseña que cifra el certificado del cliente KMIP.
kmipClientCertPath	string	La ruta al directorio en el host de Backup Daemon que almacena el certificado de cliente KMIP.
enlaces	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.
filtro de etiquetas	matriz de cadenas	Una matriz de etiquetas que limita qué daemons de respaldo y almacenes de instantáneas pueden procesar trabajos de respaldo para este proyecto.
oplogStoreFilter	matriz de objetos	Una matriz de identificadores únicos que representan almacenes Oplog que pueden usarse con los trabajos de respaldo de este proyecto.
oplogStoreFilter.id	string	Identificador único que representa un almacén de registros de operaciones que se puede utilizar con los trabajos de respaldo de este proyecto.
oplogStoreFilter.type	string	Tipo de almacén de registros de operaciones que se utilizará. Este valor siempre `oplogStore` es.
snapshotStoreFilter	matriz de objetos	Matriz de identificadores únicos que representan almacenes de instantáneas 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 almacenes de instantáneas disponibles.
snapshotStoreFilter.id	string	El identificador único que representa almacenes de instantáneas específicos que se pueden utilizar con los trabajos de respaldo de este proyecto.
tipo de filtro de tienda de instantáneas	string	El tipo de almacén de instantáneas específico se indica como `snapshotStoreFilter.id`. Los valores aceptados para esta opción son: `s3blockstore` `blockstore` `fileSystemStore`
Filtro de almacenamiento de sincronización	matriz 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.

Ejemplo de solicitud

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'

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

{
  "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 identificación

Update

Resource

Parámetros de la ruta de solicitud

Parámetros de consulta de solicitud