URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
POST /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs
Parámetros de ruta de solicitud
Nombre | Tipo | Descripción |
|---|---|---|
| string | Identificador único del proyecto que posee la tarea. |
| string | Identificador único del clúster 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 señala si el cuerpo de la respuesta debe estar en un pretty-print formato. |
| ||||||
envelope | booleano | Opcional | Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos Los clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar este problema, configure 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 |
|---|---|---|---|
| Objeto | Requerido | El método y los detalles de cómo se entregan los datos del snapshot restaurado. |
delivery.expires | string | Condicional | Marca de tiempo en ISO 8601 formato de fecha y hora en UTC después del cual la URL ya no está disponible. Si estableces |
delivery.expirationHours | Número | Condicional | Número de horas que el URL de descarga es válido una vez completado la tarea de restauración. Si estableces |
delivery.maxDownloads | Número | Requerido | Número de veces que se puede utilizar la URL de descarga. Esto debe ser |
delivery.methodName | string | Requerido | Medios por los cuales Ops Manager entrega los datos. Establecido en |
| string | Requerido | Identificador único de la snapshot que se va a restaurar. |
Nota
Condición
Si configuras "delivery.methodName" :
AUTOMATED_RESTORE", debes configurar delivery.targetGroupId y delivery.targetClusterId.
Cree una restauración automatizada a partir de una snapshot.
Nombre | Tipo | Necesidad | Descripción |
|---|---|---|---|
| Objeto | Requerido | El método y los detalles de cómo se entregan los datos del snapshot restaurado. |
delivery.methodName | string | Requerido | Medios por los cuales Ops Manager entrega los datos. Establecido en La respuesta muestra el IMPORTANTE: Se eliminó la restauración de entregas mediante SCP en Ops Manager 4.0. |
delivery.targetClusterId | string | Requerido | Identificador único del clúster de destino. Utiliza el Si la copia de seguridad no está habilitada en el clúster de destino, el endpoint Obtener todas las snapshot retorna un arreglo |
delivery.targetGroupId | string | Requerido | Identificador único del proyecto que contiene el clúster de destino para la tarea de restauración. |
| string | Requerido | Identificador único de la snapshot que se va a restaurar. |
Crear una restauración automatizada a partir de una marca de tiempo del Oplog.
Las restauraciones de Oplog funcionan con conjuntos de réplicas que utilizan cualquier versión de MongoDB o clústeres que utilizan compatibilidad de características entre versiones de 4.2 o posterior.
Nombre | Tipo | Necesidad | Descripción |
|---|---|---|---|
| Objeto | Requerido | El método y los detalles de cómo se entregan los datos del snapshot restaurado. |
delivery.methodName | string | Requerido | Medios por los cuales Ops Manager entrega los datos. Establecido en La respuesta muestra el IMPORTANTE: Se eliminó la restauración de entregas mediante SCP en Ops Manager 4.0. |
delivery.targetClusterId | string | Requerido | 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 |
delivery.targetGroupId | string | Requerido | Identificador único del proyecto que contiene el clúster de destino para la tarea de restauración. |
| string | Requerido | 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 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 | Requerido | Ordinal incremental de 32 bits que representa operaciones dentro de un segundo dado. Cuando se utilizan junto con 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 |
Crea una restauración automatizada desde un punto específico en el tiempo.
La restauración de PIT funciona con los sets de réplicas utilizando cualquier versión de MongoDB o clústeres utilizando compatibilidad de características entre versiones de 4.2 o posterior.
Nombre | Tipo | Necesidad | Descripción |
|---|---|---|---|
| Objeto | Requerido | El método y los detalles de cómo se entregan los datos del snapshot restaurado. |
delivery.methodName | string | Requerido | Medios por los cuales Ops Manager entrega los datos. Establecido en La respuesta muestra el IMPORTANTE: Se eliminó la restauración de entregas mediante SCP en Ops Manager 4.0. |
delivery.targetClusterId | string | Requerido | 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 |
delivery.targetGroupId | string | Requerido | Identificador único del proyecto que contiene el clúster de destino para la tarea de restauración. |
| long | Requerido | marca de tiempo en el número de milisegundos que han transcurrido desde la UNIX epoch que representa el punto en el tiempo al que sus datos serán restaurados. Este registro debe estar dentro de las últimas 24 horas desde la hora 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 |
Respuesta
Documento de respuesta
El documento de respuesta JSON incluye un arreglo de result objetos, un arreglo de link objetos y una cantidad del número total de result objetos recuperados.
Nombre | Tipo | Descripción |
|---|---|---|
| arreglo | El arreglo incluye un objeto para cada elemento detallado en la sección del |
| arreglo | El arreglo incluye uno o más enlaces a subrecursos y/o recursos relacionados. Las relaciones entre URLse explican en la Especificación de enlace web. |
| Número | Recuento entero del número total de elementos en el conjunto de resultados. Puede ser superior al número de objetos en el arreglo results si el conjunto de resultados completo está paginado. |
results embeddedDocument
Cada resultado es una tarea de restauración de clúster. Este arreglo incluye solo una tarea de restauración.
Nombre | Tipo | Descripción | |||
|---|---|---|---|---|---|
| string | Identificador único del agrupar al que pertenece esta tarea de restauración. Devuelto si el snapshot era de un clúster partitioned. | |||
| string | Identificador único del clúster que representa la tarea de restauración. Se devuelve si la snapshot era de un set de réplicas o clúster. | |||
| string | Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando se solicitó la tarea de restauración. | |||
| Objeto | El método y los detalles de cómo se entregan los datos del snapshot restaurado. | |||
delivery.authBearer | string | Portador de autorización para solicitudes a | |||
delivery.authHeader | string | Encabezado de autorización para solicitudes a | |||
delivery.authValue | string | Valor para el portador para solicitudes a | |||
delivery.expirationHours | Número | Número de horas que el URL de descarga es válido una vez completado la tarea de restauración. | |||
delivery.expires | string | Marca de tiempo en ISO 8601 formato de fecha y hora en UTC después del cual la URL ya no está disponible. | |||
delivery.maxDownloads | Número | Número de veces que se puede utilizar la URL de descarga. Esto debe ser | |||
delivery.methodName | string | Medios por los cuales se entrega la información. Devuelve | |||
delivery.statusName | string | Estado actual del archivo descargable. Los valores aceptados son:
| |||
delivery.url | string | URL desde la cual se puede descargar la snapshot restaurada. | |||
delivery.urlV2 | string | URL desde la cual se pueden descargar de forma segura los datos restaurados de la snapshot . Las solicitudes a esta URL deben incluir el Por ejemplo: | |||
| string | Identificador único del grupo que es dueño de la tarea de restauración. | |||
| Arreglo de objetos | Si se ha descargado el | |||
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 hash utilizado para calcular el valor hash. Si se devuelve, el valor se establece en | |||
| string | Identificador único del servidor de configuración al que pertenece esta tarea de restauración. Se devuelve si servidor de configuración era un SCCC. | |||
| string | Identificador único de la tarea de restauración. | |||
| Arreglo de objetos | Uno o más enlaces a subrecursos o recursos relacionados. Todos los arreglos | |||
| booleano | Indicador de si la snapshot corresponde a un punto en el tiempo. | |||
| string | Identificador único de la snapshot que se va a restaurar. | |||
| string | Estado actual de la tarea. Los valores aceptados son:
| |||
| Objeto | Marca de tiempo de la entrada de Oplog cuando se creó el snapshot. | |||
timestamp.date | string | Marca de tiempo en ISO 8601 formato de fecha y hora en UTC del último registro de oplog en el snapshot restaurado. | |||
timestamp.increment | string | Orden de todas las operaciones completadas en la última entrada de oplog en la snapshot restaurada. |
Nombre | Tipo | Descripción |
|---|---|---|
| string | Identificador único del agrupar al que pertenece esta tarea de restauración. Devuelto si el snapshot era de un clúster partitioned. |
| string | Identificador único del clúster que representa la tarea de restauración. Se devuelve si la snapshot era de un set de réplicas o clúster. |
| string | Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando se solicitó la tarea de restauración. |
| Objeto | El método y los detalles de cómo se entregan los datos del snapshot restaurado. |
delivery.methodName | string | Medios por los cuales se entrega la información. Devuelve |
delivery.targetClusterId | string | Identificador único del clúster de destino para realizar la tarea de restauración. |
delivery.targetGroupId | string | Identificador único del proyecto que contiene el clúster de destino para la tarea de restauración. |
| string | Identificador único del grupo que es dueño de la tarea de restauración. |
| string | Identificador único del servidor de configuración al que pertenece esta tarea de restauración. Se devuelve si servidor de configuración era un SCCC. |
| string | Identificador único de la tarea de restauración. |
| objeto arreglo | Uno o más enlaces a subrecursos o recursos relacionados. Todos los arreglos |
| booleano | Indicador de si la snapshot corresponde a un punto en el tiempo. |
| string | Identificador único de la snapshot que se va a restaurar. |
| string | Estado actual de la tarea. Los valores aceptados son:
|
| Objeto | Marca de tiempo de la entrada de Oplog cuando se creó el snapshot. |
timestamp.date | string | Marca de tiempo en ISO 8601 formato de fecha y hora en UTC del último registro de oplog en el snapshot restaurado. |
timestamp.increment | string | Orden de todas las operaciones completadas en la última entrada de oplog en la snapshot restaurada. |
Nombre | Tipo | Descripción |
|---|---|---|
| string | Identificador único del agrupar al que pertenece esta tarea de restauración. Devuelto si el snapshot era de un clúster partitioned. |
| string | Identificador único del clúster que representa la tarea de restauración. Se devuelve si la snapshot era de un set de réplicas o clúster. |
| string | Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando se solicitó la tarea de restauración. |
| Objeto | El método y los detalles de cómo se entregan los datos del snapshot restaurado. |
delivery.methodName | string | Medios por los cuales se entrega la información. Devuelve |
delivery.targetClusterId | string | Identificador único del clúster de destino para realizar la tarea de restauración. |
delivery.targetGroupId | string | Identificador único del proyecto que contiene el clúster de destino para la tarea de restauración. |
| string | Identificador único del grupo que es dueño de la tarea de restauración. |
| string | Identificador único del servidor de configuración al que pertenece esta tarea de restauración. Se devuelve si servidor de configuración era un SCCC. |
| string | Identificador único de la tarea de restauración. |
| objeto arreglo | Uno o más enlaces a subrecursos o recursos relacionados. Todos los arreglos |
| booleano | Indicador de si la snapshot corresponde a un punto en el tiempo. |
| string | Identificador único de la snapshot que se va a restaurar. |
| string | Estado actual de la tarea. Los valores aceptados son:
|
| Objeto | Marca de tiempo de la entrada de Oplog cuando se creó el snapshot. |
timestamp.date | string | Marca de tiempo en ISO 8601 formato de fecha y hora en UTC del último registro de oplog en el snapshot restaurado. |
timestamp.increment | string | Orden de todas las operaciones completadas en la última entrada de oplog en la snapshot restaurada. |
Nombre | Tipo | Descripción |
|---|---|---|
| string | Identificador único del agrupar al que pertenece esta tarea de restauración. Devuelto si el snapshot era de un clúster partitioned. |
| string | Identificador único del clúster que representa la tarea de restauración. Se devuelve si la snapshot era de un set de réplicas o clúster. |
| string | Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando se solicitó la tarea de restauración. |
| Objeto | El método y los detalles de cómo se entregan los datos del snapshot restaurado. |
delivery.methodName | string | Medios por los cuales se entrega la información. Devuelve |
delivery.targetClusterId | string | Identificador único del clúster de destino para realizar la tarea de restauración. |
delivery.targetGroupId | string | Identificador único del proyecto que contiene el clúster de destino para la tarea de restauración. |
| string | Identificador único del grupo que es dueño de la tarea de restauración. |
| string | Identificador único del servidor de configuración al que pertenece esta tarea de restauración. Se devuelve si servidor de configuración era un SCCC. |
| string | Identificador único de la tarea de restauración. |
| objeto arreglo | Uno o más enlaces a subrecursos o recursos relacionados. Todos los arreglos |
| booleano | Indicador de si la snapshot corresponde a un punto en el tiempo. |
| string | Identificador único de la snapshot que se va a restaurar. |
| string | Estado actual de la tarea. Los valores aceptados son:
|
| Objeto | Marca de tiempo de la entrada de Oplog cuando se creó el snapshot. |
timestamp.date | string | Marca de tiempo en ISO 8601 formato de fecha y hora en UTC del último registro de oplog en el snapshot restaurado. |
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://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true" \ --data ' { "delivery" : { "expirationHours" : "1", "maxDownloads" : "1", "methodName" : "HTTP" }, "snapshotId" : "{SNAPSHOT-ID}" }'
Cree una restauración automatizada a partir de una snapshot.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true" \ --data ' { "delivery" : { "methodName" : "AUTOMATED_RESTORE", "targetGroupId" : "{TARGET-PROJECT-ID}", "targetClusterId" : "{TARGET-CLUSTER-ID}" }, "snapshotId": "{SNAPSHOT-ID}" }'
Crear una restauración automatizada a partir de una marca de tiempo del Oplog.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true" \ --data ' { "delivery" : { "methodName" : "AUTOMATED_RESTORE", "targetGroupId" : "{TARGET-PROJECT-ID}", "targetClusterId" : "{TARGET-CLUSTER-ID}" }, "oplogTs" : "1536610288", "oplogInc" : "1" }'
Crea una restauración automatizada desde un punto específico en el tiempo.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true" \ --data ' { "delivery" : { "methodName" : "AUTOMATED_RESTORE", "targetGroupId" : "{TARGET-PROJECT-ID}", "targetClusterId" : "{TARGET-CLUSTER-ID}" }, "pointInTimeUTCMillis" : "1536610288000" }'
Ejemplo de respuestas
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
{ "links" : [ { "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true&pageNum=1&itemsPerPage=100", "rel" : "self" } ], "results" : [ { "batchId": "{BATCH-ID}", "clusterId": "{CLUSTER-ID}", "created": "2018-09-20T15:00:00Z", "delivery": { "authBearer": "Bearer", "authHeader": "Authorization", "expirationHours": 1, "maxDownloads": 1, "methodName": "HTTP", "statusName": "READY" }, "encryptionEnabled": false, "groupId": "{PROJECT-ID}", "id": "{RESTORE-JOB-ID}", "links": [{ "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-NAME}/restoreJobs/{RESTORE-JOB-ID}", "rel": "self" }], "pointInTime": false, "snapshotId": "{SNAPSHOT-ID}", "statusName": "FINISHED", "timestamp": { "date": "2018-09-15T15:53:00Z", "increment": 1 } } ], "totalCount" : 1, "url": "{DOWNLOAD-URL}", "urlV2": "https://{OPSMANAGER-HOST}:{PORT}/backup/restore/v3/pull/{restoreJobId}/{filename}" }
{ "links" : [ { "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true&pageNum=1&itemsPerPage=100", "rel" : "self" } ], "results" : [ { "batchId" : "{BATCH-ID}", "clusterId" : "{CLUSTER-ID}", "created" : "2020-04-21T03:49:57Z", "delivery" : { "expirationHours" : 1, "expires" : "2020-04-21T04:49:57Z", "maxDownloads" : 1, "methodName" : "HTTP", "statusName" : "READY", "url" : "https://{OPSMANAGER-HOST}:{PORT}/backup/restore/v2/pull/{JOB-ID}/OTY0ZmFiNmEzZjEzNGUyMTlhZjJjNjM3NGMyNGM4ZTM=/electron_0-1492636465-{JOB-ID}.tar.gz" }, "encryptionEnabled" : false, "groupId" : "{PROJECT-ID}", "id" : "{JOB-ID}", "links" : [ { "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs/{JOB-ID}", "rel" : "self" } ], "snapshotId" : "{SNAPSHOT-ID}", "statusName" : "FINISHED", "timestamp" : { "date" : "2020-04-18T15:14:25Z", "increment" : 1 } } ], "totalCount" : 1 }
{ "links" : [ { "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true&pageNum=1&itemsPerPage=100", "rel" : "self" } ], "results" : [ { "batchId": "{BATCH-ID}", "clusterId": "{CLUSTER-ID}", "created": "2018-09-20T15:01:00Z", "delivery": { "methodName": "HTTP", "statusName": "READY" }, "encryptionEnabled": false, "groupId": "{PROJECT-ID}", "id": "{RESTORE-JOB-ID}", "links": [{ "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-NAME}/restoreJobs/{RESTORE-JOB-ID}", "rel": "self" }], "pointInTime": false, "snapshotId": "{SNAPSHOT-ID}", "statusName": "FINISHED", "timestamp": { "date": "2018-09-15T15:53:00Z", "increment": 1 } } ], "totalCount" : 1 }
{ "links" : [ { "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true&pageNum=1&itemsPerPage=100", "rel" : "self" } ], "results" : [ { "batchId": "{BATCH-ID}", "clusterId": "{CLUSTER-ID}", "created": "2018-09-20T15:02:00Z", "delivery": { "methodName": "HTTP", "statusName": "READY" }, "encryptionEnabled": false, "groupId": "{PROJECT-ID}", "id": "{RESTORE-JOB-ID}", "links": [{ "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-NAME}/restoreJobs/{RESTORE-JOB-ID}", "rel": "self" }], "snapshotId": "{SNAPSHOT-ID}", "statusName": "FINISHED", "timestamp": { "date": "2018-09-15T15:53:00Z", "increment": 1 } } ], "totalCount" : 1 }
{ "links" : [ { "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true&pageNum=1&itemsPerPage=100", "rel" : "self" } ], "results" : [ { "batchId": "{BATCH-ID}", "clusterId": "{CLUSTER-ID}", "created": "2018-09-20T15:03:00Z", "delivery": { "methodName": "HTTP", "statusName": "READY" }, "encryptionEnabled": false, "groupId": "{PROJECT-ID}", "id": "{RESTORE-JOB-ID}", "links": [{ "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-NAME}/restoreJobs/{RESTORE-JOB-ID}", "rel": "self" }], "snapshotId": "{SNAPSHOT-ID}", "statusName": "FINISHED", "timestamp": { "date": "2018-09-15T15:53:00Z", "increment": 1 } } ], "totalCount" : 1 }