Nota
Grupos y proyectos son términos sinónimos. Su {PROJECT-ID} es el mismo que su ID del grupo. Para los grupos existentes, el ID del grupo se mantiene igual. Esta página utiliza el término más familiar grupo cuando se refiere a descripciones. El endpoint permanece tal 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 ruta de solicitud
Nombre | Tipo | Necesidad | DescripciĂłn |
|---|---|---|---|
PROJECT-ID | string | Requerido | string Ăşnica de 24 dĂgitos hexadecimales que identifica el proyecto al que aplica la configuraciĂłn de copia de seguridad. |
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. |
|
elementosPorPágina | Número | Opcional | Número de elementos a devolver por página, hasta un máximo de 500. |
|
bonito | booleano | Opcional | Indicador que señala si el cuerpo de la respuesta debe estar en formato prettyprint. |
|
envelope | booleano | Opcional | Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos clientes API no pueden acceder a los encabezados de respuesta HTTP o al cĂłdigo de estado. Para remediarlo, establezca Para los endpoints que devuelven una lista de resultados, el objeto |
|
Parámetros del cuerpo de la solicitud
Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.
Respuesta
Nombre | Tipo | DescripciĂłn |
|---|---|---|
ID del grupo | string | string Ăšnica de 24 dĂgitos hexadecimales que identifica el Proyecto que posee esta configuraciĂłn de copia de seguridad. |
clusterId | string | string Ăşnica de 24 dĂgitos hexadecimales que identifica el clĂşster cuya configuraciĂłn de copia de seguridad deseas encontrar. |
Nombre del estado | string | Estado actual (o deseado) de la configuraciĂłn de la copia de seguridad. Los valores posibles son:
|
storageEngineName | string | Motor de almacenamiento utilizado para la copia de seguridad. Los valores posibles son:
|
encryptionEnabled | booleano | Indicador que señala si el cifrado está activado para la configuraciĂłn de copia de seguridad. Debes incluir el campo compatibilidad de caracterĂsticas entre versiones Para obtener más informaciĂłn sobre el cifrado de copias de seguridad para FCV 4.2 o posterior, consulta Instantáneas cifradas de copias de seguridad. |
sslEnabled | booleano | Indicador que señala si TLS está habilitado para la base de datos fuente de sincronización. |
espacios de nombres excluidos | arreglo de string | Lista de nombres de bases de datos y nombres de colecciones para omitir en la copia de seguridad. Cada string es un espacio de nombres con la forma de Debe enviar la nueva lista completa de espacios de nombres excluidos, incluidos los que ya estaban listados. Si la nueva lista remueve algún espacio de nombres de la lista anterior, también debes configurar el campo Si la nueva lista solo añade a la lista anterior, no necesitas establecer |
includedNamespaces | arreglo de string | Lista de nombres de bases de datos y nombres de colecciones para incluir en la copia de seguridad. Cada string es un espacio de nombres con la forma de Debes enviar la nueva lista completa de namespaces incluidos, incluso aquellos que ya estaban listados. Si la nueva lista agrega cualquier espacio de nombres a la lista anterior, también debes configurar el campo Si la nueva lista solo remueve namespace de la lista anterior, no necesitas configurar |
Solicitud de ejemplo
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"
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
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 }