URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
POST /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs/restorableTimeRanges
Devuelve los rangos de tiempo restaurables para un set de réplicas o clúster particionado habilitado para copias de seguridad en un proyecto. Cada rango de tiempo restaurable representa una ventana continua del historial de oplog a la que Ops Manager puede restaurar de forma segura.
Permisos requeridos
Debe tener el rol Global Backup Admin, Project Backup Admin o Global Read Only para llamar a este endpoint.
Request Parameters
Parámetros de ruta de solicitud
Nombre | Tipo | Descripción |
|---|---|---|
| string | string única de 24dígitos hexadecimales que identifica el Proyecto propietario del clúster. |
| string | string única de 24dígitos hexadecimales que identifica el clúster habilitado para copias de seguridad cuyos rangos de tiempo restaurables desea devolver. |
Parámetros de Solicitud Query
Los siguientes parámetros de query son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado |
|---|---|---|---|---|
bonito | booleano | Opcional | Indicador que muestra si el cuerpo de la respuesta está en formato pretty-print. |
|
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 ni al código de estado. Para solucionar esto, ajusta 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
El cuerpo de la respuesta contiene un arreglo de rango de tiempo restaurables. Para set de réplicas, cada elemento contiene los siguientes campos:
Nombre | Tipo | Descripción |
|---|---|---|
| Marca de tiempo BSON | Punto más temprano en el tiempo en este rango restaurable. Este valor es un objeto de marca de tiempo BSON con campos |
| Marca de tiempo BSON | Último punto en el tiempo en este rango restaurable. MongoDB Ops Manager puede restaurar de forma segura a cualquier momento entre |
| string | string única de 24dígitos hexadecimales que identifica la snapshot o clustershot asociada con este rango. |
Para clústeres particionados, cada elemento también incluye:
Nombre | Tipo | Descripción |
|---|---|---|
| entero | Número de particiones que participan en este rango de tiempo restaurable. |
| string | Etiqueta legible por humanos que indica si el clúster particionado utiliza una implementación de servidor de configuración incrustada o dedicada. |
MongoDB Ops Manager devuelve los rango de tiempo restaurables ordenados de la hora de inicio más temprana a la más reciente.
Solicitud de ejemplo
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs/restorableTimeRanges?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
[ { "end" : { "date" : "2021-07-17T19:00:00Z", "increment" : 1 }, "snapshotId" : "{SNAPSHOT-ID}", "start" : { "date" : "2021-07-14T00:00:00Z", "increment" : 1 } } ]