Recupera la configuración de los trabajos de respaldo de un proyecto.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource
GET /groups/{PROJECT-ID}
Parámetros de la ruta de solicitud
Nombre | Tipo | Descripción |
|---|---|---|
PROJECT-ID | string | El identificador único que representa este proyecto y su configuración de trabajo 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. |
| ||||||
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:
|
|
Parámetros del cuerpo de la solicitud
Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.
Respuesta
Nombre | Tipo | Descripción |
|---|---|---|
daemonFilter | matriz de objetos | Una matriz de pares de hosts de Backup Daemon y sus directorios principales a los que se limitan 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 |
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 |
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 Los valores aceptados para esta opción son:
|
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/{PROJECT-ID}?pretty=true'
Ejemplo de respuesta
Encabezado de respuesta
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}
Cuerpo de respuesta
{ "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" ] }