Nota
Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} Es el mismo que el ID de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. Esta página utiliza el término "grupo" para las descripciones. El punto final se mantiene como se indica en el documento.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/backupConfigs
Request Parameters
Parámetros de la ruta de solicitud
Nombre | Tipo | Necesidad | Descripción |
|---|---|---|---|
PROJECT-ID | string | Requerido | Cadena de dígitos hexadecimales 24única que identifica el proyecto al que se aplica la configuración de respaldo. |
Parámetros de consulta de solicitud
Los siguientes parámetros de consulta son opcionales:
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. |
|
artículos por página | Número | Opcional | Número de artículos a devolver por página, hasta un máximo de 500. |
|
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 Para los puntos finales que devuelven una lista de resultados, el objeto |
|
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 |
|
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 |
|---|---|---|
ID de grupo | string | Cadena de dígitos hexadecimales 24única que identifica el proyecto que posee esta configuración de respaldo. |
clusterId | string | string única de 24 dígitos hexadecimales que identifica el clúster cuya configuración de copia de seguridad deseas encontrar. |
nombreDeEstado | string | Estado actual (o deseado) de la configuración de la copia de seguridad. Los valores posibles son:
|
nombreDeMotorDeAlmacenamiento | string | Motor de almacenamiento utilizado para la copia de seguridad. Los valores posibles son:
|
encryptionEnabled | booleano | Indicador que indica si el cifrado está habilitado para la configuración de copia de seguridad. Debe incluir el FCV Para obtener más información sobre el cifrado de respaldo para FCV 4.2 o posterior, consulte Instantáneas de respaldo cifradas. |
SSL habilitado | booleano | Bandera que indica si TLS está habilitado para la base de datos de origen de sincronización. |
espacios de nombres excluidos | matriz de cadenas | Lista de nombres de bases de datos y colecciones que se omitirán en la copia de seguridad. Cada cadena es un espacio de nombres con el formato Debe enviar la nueva lista completa de espacios de nombres excluidos, incluidos todos los que ya estaban incluidos. Si la nueva lista elimina algún espacio de nombres de la lista anterior, también debe configurar el campo Si la nueva lista solo se agrega a la lista anterior, no es necesario configurar |
espacios de nombres incluidos | matriz de cadenas | Lista de nombres de bases de datos y colecciones que se incluirán en la copia de seguridad. Cada cadena es un espacio de nombres con el Debe enviar la nueva lista completa de espacios de nombres incluidos, incluidos todos los que ya estaban enumerados. Si la nueva lista añade espacios de nombres a la lista anterior, también debe configurar el campo Si la nueva lista solo elimina espacios de nombres de la lista anterior, no es necesario configurar |
Ejemplo de solicitud
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs"
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
1 { 2 "totalCount" : 3, 3 "results" : [ { 4 "groupId" : "{PROJECT-ID}", 5 "clusterId" : "{CLUSTER-ID1}", 6 "statusName" : "STARTED", 7 "storageEngineName" : "WIRED_TIGER", 8 "sslEnabled" : false, 9 "excludedNamespaces" : [ ], 10 "includedNamespaces" : [ ], 11 "links" : [ ] 12 }, { 13 "groupId" : "{PROJECT-ID}", 14 "clusterId" : "{CLUSTER-ID2}", 15 "statusName" : "STARTED", 16 "storageEngineName" : "MEMORY_MAPPED", 17 "sslEnabled" : false, 18 "excludedNamespaces" : [ ], 19 "includedNamespaces" : [ ], 20 "links" : [ ] 21 }, { 22 "groupId" : "{PROJECT-ID}", 23 "clusterId" : "{CLUSTER-ID3}", 24 "statusName" : "STOPPED", 25 "storageEngineName" : "WIRED_TIGER", 26 "sslEnabled" : false, 27 "excludedNamespaces" : [ ], 28 "includedNamespaces" : [ ], 29 "links" : [ ] 30 } ], 31 "links" : [ ] 32 }