Recupera la configuración de las tareas de copia de seguridad de un proyecto.
Nota
Ops Manager devuelve un error si no existe una configuración de tareas de copia de seguridad de Proyecto con la ID especificada. Puedes modificar la configuración de tareas de copia de seguridad de un Proyecto desde el UI or API. Para recuperar las IDs de todas las configuraciones de trabajos de copia de seguridad de proyectos, utiliza el punto final Obtener todas las configuraciones de trabajos de copia de seguridad de proyectos.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource
GET /groups/{PROJECT-ID}
Parámetros de ruta de solicitud
Nombre | Tipo | Descripción |
|---|---|---|
PROJECT-ID | string | El identificador único que representa este proyecto y la configuración de su tarea de copia de seguridad. |
Parámetros de Solicitud Query
Los siguientes parámetros de query son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
bonito | booleano | Opcional | Indicador que señala si el cuerpo de la respuesta debe estar en un pretty-print formato. |
| ||||||
envelope | booleano | Opcional | Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos Los clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar este problema, configure envelope=true en la query. Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:
|
|
Parámetros del cuerpo de la solicitud
Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.
Respuesta
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 daemon de copias de seguridad host. |
daemonFilter.machine | string | La dirección del host de un host daemon de copias de seguridad. |
ID | string | El identificador único que representa este proyecto y la configuración de su tarea de copia de seguridad. |
kmipClientCertPassword | string | La contraseña que cifra el certificado de cliente KMIP. |
kmipClientCertPath | string | La ruta al directorio en el host del daemon de copias de seguridad que almacena el certificado de cliente KMIP. |
enlaces | objeto arreglo | Uno o más enlaces a subrecursos o recursos relacionados. Todos los arreglos |
labelFilter | 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 para usar. Los valores aceptados son:
|
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 Los valores aceptados para esta opción son:
|
syncStoreFilter | Arreglo de cadenas | Una matriz de filtros de almacén de sincronización que se pueden usar con las tareas de copia de seguridad de este proyecto. Si se omite, se utilizan todas las tiendas 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/{PROJECT-ID}?pretty=true'
Respuesta de ejemplo
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}
Respuesta del cuerpo
{ "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" ] }