URL base: https://cloud.mongodb.com/api/public/v1.0
Resource
POST /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs/restorableTimeRanges
Devuelve los rangos de tiempo restaurables para un conjunto de réplicas o clúster fragmentado con copia de seguridad habilitada en un proyecto. Cada rango de tiempo restaurable representa una ventana continua del historial de oplog a la que Cloud Manager puede restaurar de forma segura.
Permisos requeridos
Debes tener el Project Backup Admin rol o para llamar a este endpoint.Organization Read Only
Request Parameters
Parámetros de ruta de solicitud
Nombre | Tipo | Descripción |
|---|---|---|
| string | Cadena única de dígitos hexadecimales 24que identifica el proyecto propietario del clúster. |
| string | Cadena única de dígitos hexadecimales 24que 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 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 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 una matriz de rangos de tiempo restaurables. Para los conjuntos de réplicas, cada elemento contiene los siguientes campos:
Nombre | Tipo | Descripción |
|---|---|---|
| marca de tiempo BSON | Punto más temprano en el tiempo dentro de este rango restaurable. Este valor es un objeto de marca de tiempo BSON con campos |
| marca de tiempo BSON | Último punto en el tiempo dentro de este rango restaurable. Cloud Manager puede restaurar de forma segura a cualquier momento entre |
| string | Cadena única de dígitos hexadecimales 24que identifica la instantánea o la instantánea de clúster asociada a este rango. |
Para los clústeres fragmentados, cada elemento también incluye:
Nombre | Tipo | Descripción |
|---|---|---|
| entero | Número de fragmentos que participan en este intervalo de tiempo restaurable. |
| string | Etiqueta legible para humanos que indica si el clúster fragmentado utiliza una implementación de servidor de configuración integrado o dedicado. |
Cloud Manager devuelve los rangos de tiempo restaurables ordenados desde la hora de inicio más temprana hasta la más tardía.
Solicitud de ejemplo
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://cloud.mongodb.com/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 } } ]