URL base: https://cloud.mongodb.com/api/public/v1.0
Resource
POST /groups/{PROJECT-ID}/hosts/{HOST-ID}/restoreJobsParámetros de ruta de solicitud
Nombre | Tipo | Descripción |
|---|---|---|
PROJECT-ID | string | Identificador único del proyecto que es propietario de la tarea. |
ID DEL HOST | string | Identificador único del servidor de configuración replicado (SCCC) que representa la tarea. |
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 se debe devolver el cuerpo de la respuesta en un prettyprint formato. |
|
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, establezca 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
Nombre | Tipo | Necesidad | Descripción |
|---|---|---|---|
| string | Condicional | Identificador único para el clúster particionado punto de control que representa el momento en el cual se restaurarán tus datos. Condiciones:
Si estableces este parámetro, este endpoint restaurará todos los datos hasta este punto de control en la base de datos que especificaste en el objeto |
| Objeto | Requerido | El método y los detalles de cómo se entregan los datos del snapshot restaurado. |
| string | Condicional | Marca de tiempo en formato de fecha y hora ISO 8601 en UTC después de lo cual la URL ya no está disponible.
|
| Número | Condicional | Número de horas que el URL de descarga es válido una vez completado la tarea de restauración.
|
| Número | Condicional | Número de veces que se puede usar la URL de descargar. Esto debe ser
|
| string | Requerido | Medio por el cual Cloud Manager entrega los datos. Los valores aceptados son:
Si se establece
Además, la respuesta muestra el IMPORTANTE: La entrega de restauración a través de SCP se ha eliminado a partir del 27 de marzo de 2018. |
| string | Condicional | Identificador único del clúster de destino. Use el
Si la copia de seguridad no está habilitada en el clúster de destino, el endpoint Obtener todas las snapshot retorna un arreglo |
| string | Condicional | Identificador único del proyecto que contiene el clúster de destino para la tarea de restauración.
|
| string | Condicional | Oplog timestamp proporcionado como una Marca de Tiempo representada por el número de segundos transcurridos desde la Unix epoch. Cuando se combinan con Ejecute una query contra
Si estableces
Si proporcionas este parámetro, este endpoint restablece todos los datos hasta e incluyendo esta marca de tiempo Oplog en la base de datos que especificaste en el objeto |
| string | Condicional | Ordinal incremental de 32 bits que representa operaciones dentro de un segundo dado. Cuando se utilizan junto con
Si estableces
Si proporcionas este parámetro, este endpoint restablece todos los datos hasta e incluyendo esta marca de tiempo Oplog en la base de datos que especificaste en el objeto |
| long | Condicional | timestamp en el número de milisegundos que han transcurrido desde la época UNIX', que representa el punto en el tiempo al que se restaurarán tus datos. Esta marca de tiempo debe estar dentro de las últimas 24 horas desde el momento actual. Si se proporciona esta configuración, este endpoint restaurará todos los datos hasta este Punto en el tiempo a la base de datos que haya especificado en el objeto
Si estableces |
| string | Condicional | Identificador único de la snapshot que se va a restaurar. |
Respuesta
Nombre | Tipo | Descripción |
|---|---|---|
batchId | string | Condicional: clúster particionado only. Identificador único del lote al que pertenece esta tarea de restauración. |
clusterId | string | |
creado | string | Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando se solicitó la tarea de restauración. |
entrega | Objeto | El método y los detalles de cómo se entregan los datos del snapshot restaurado. |
delivery.expirationHour | Número | Condicional: |
delivery.expires | string | Condicional: |
delivery.maxDownloads | Número | Condicional: |
delivery.methodName | string | Medios por los cuales se entregan los datos. El valor aceptado es IMPORTANTE: La entrega de restauración a través de SCP se ha eliminado a partir del 27 de marzo de 2018. |
Estado del envío | string | Estado actual del archivo descargable. Los valores aceptados son:
|
delivery.targetClusterId | string | Condicional: |
delivery.targetGroupId | string | Condicional: |
delivery.url | string | Condicional: |
ID del grupo | string | Identificador único del grupo que es dueño de la tarea de restauración. |
encriptada | objeto arreglo | Si el correspondiente Para una restauración de |
hashes.fileName | string | Nombre del archivo de instantánea que ha sido encriptada. |
hashes.hash | string | Hash del archivo de snapshot. |
hashes.typeName | string | Algoritmo de hashing utilizado para calcular el valor de hash. Si está presente, este valor es |
hostId | string | Condicional: servidor de configuración reflejado (SCCC). Identificador único del servidor de configuración al que pertenece esta tarea de restauración. |
ID | string | Identificador único de la tarea de restauración. |
enlaces | objeto arreglo | Uno o más enlaces a subrecursos y/o recursos relacionados. Todos los arreglos |
snapshotId | string | Identificador único de la snapshot que se va a restaurar. |
Nombre del estado | string | Estado actual de la tarea. Los valores aceptados son:
|
Marca de tiempo | Objeto | Marca de tiempo de la entrada de Oplog cuando se creó el snapshot. |
timestamp.date | string | Marca de tiempo en el formato de fecha y hora ISO 8601 en UTC de la última entrada de oplog en el snapshot de restauración. |
timestamp.increment | string | Orden de todas las operaciones completadas en la última entrada de oplog en la snapshot restaurada. |
Solicitud de ejemplo
Crea una tarea de restauración que transfiera una snapshot comprimida utilizando HTTP.
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}/hosts/{HOST-ID}/restoreJobs?pretty=true" \ --data ' { "delivery" : { "expirationHours" : 1, "expires" : "2017-04-21T04:49:57Z", "maxDownloads" : 1, "methodName" : "HTTP", "statusName" : "READY", "url" : "https://api-backup.mongodb.com/backup/restore/v2/pull/{JOB-ID}/OTY0ZmFiNmEzZjEzNGUyMTlhZjJjNjM3NGMyNGM4ZTM=/electron_0-1492636465-{JOB-ID}.tar.gz" }, "snapshotId" : "{SNAPSHOT-ID}" }'Respuesta de ejemplo
Encabezado de respuesta
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}Respuesta del cuerpo
{ "created" : "2017-08-25T16:22:15Z", "delivery" : { "expirationHours" : 1, "expires" : "2017-04-21T04:49:57Z", "maxDownloads" : 1, "methodName" : "HTTP", "statusName" : "READY", "url" : "https://api-backup.mongodb.com/backup/restore/v2/pull/{JOB-ID}/OTY0ZmFiNmEzZjEzNGUyMTlhZjJjNjM3NGMyNGM4ZTM=/electron_0-1492636465-{JOB-ID}.tar.gz" }, "encryptionEnabled" : true, "groupId" : "{PROJECT-ID}", "hostId" : "{HOST-ID}", "id" : "{JOB-ID}", "links" : [ { "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}/restoreJobs/{JOB-ID}", "rel" : "self" }, { "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}", "rel" : "http://mms.mongodb.com/cluster" }, { "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}/snapshots/{SNAPSHOT-ID}", "rel" : "http://mms.mongodb.com/snapshot" }, { "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}", "rel" : "http://mms.mongodb.com/group" } ], "masterKeyUUID" : "{UUID}", "snapshotId" : "{SNAPSHOT-ID}", "statusName" : "IN_PROGRESS"}