URL base: https://cloud.mongodb.com/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/hosts/{HOST-ID}/restoreJobs
Parámetros de la 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 host que representa la tarea. |
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 | Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint formato. |
|
envelope | booleano | Opcional | Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos Los clientes de laAPI no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure Para los endpoints que devuelven una lista de resultados, el objeto |
|
backupJobsEnabledOnly | booleano | Opcional | Indicador que indica si se deben excluir de la respuesta los daemons no habilitados para realizar copias de seguridad de bases de datos. Establezca este valor en |
|
Parámetros del cuerpo de la solicitud
Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.
Respuesta
Documento de respuesta
El documento JSON de respuesta incluye una matriz de result objetos, una matriz de link objetos y un recuento del número total de result objetos recuperados.
Nombre | Tipo | Descripción |
|---|---|---|
| arreglo | La matriz incluye un objeto para cada elemento detallado en el
Sección |
| 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 servidor de configuración.
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 | Condicional: Solo clúster. Identificador único del clúster que representa el trabajo de restauración. |
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 entrega la información. Los valores aceptados son:
IMPORTANTE: La restauración de la entrega a través de SCP se eliminó a partir de marzo 27, 2018. |
Estado del envío | string | Estado actual del archivo descargable. Los valores aceptados son:
|
entrega.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 se ha Para una restauración de |
hashes.fileName | string | Nombre del archivo de instantánea que ha sido codificado. |
hashes.hash | string | Hash del archivo de snapshot. |
hashes.typeName | string | Algoritmo hash utilizado para calcular el valor hash. Si está presente, este valor es |
hostId | string | Condicional: servidor deconfiguración reflejado (SCCC). Identificador único del servidor de configuración al que pertenece este trabajo 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 |
pointInTime | booleano | Indicador que señala que la tarea para una restauración PIT. |
snapshotId | string | Identificador único de la snapshot que se va a restaurar. |
nombreDeEstado | string | Estado actual de la tarea. Los valores aceptados son:
|
fecha y hora | Objeto | Marca de tiempo de la entrada del Oplog cuando se creó la instantánea. |
timestamp.date | string | Marca de tiempo en formato ISO 8601 de fecha y hora en UTC de la última entrada del registro de operaciones en la instantánea restaurada. |
timestamp.increment | string | Orden de todas las operaciones completadas en la última entrada del registro de operaciones en la instantánea restaurada. |
Solicitud de ejemplo
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}/restoreJobs?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
{ "links" : [ { "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}/restoreJobs?pretty=true&pageNum=1&itemsPerPage=100", "rel" : "self" } ], "results" : [ { "batchId" : "58f98165ce4bd91677fee35e", "created" : "2017-04-21T03:49:57Z", "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" : false, "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" } ], "pointInTime" : false, "snapshotId" : "{SNAPSHOT-ID}", "statusName" : "FINISHED", "timestamp" : { "date" : "2017-04-18T15:14:25Z", "increment" : 1 } }, { "batchId" : "{BATCH-ID}", "created" : "2017-04-18T19:21:23Z", "delivery" : { "expirationHours" : 1, "expires" : "2017-04-18T20:21:23Z", "maxDownloads" : 1, "methodName" : "HTTP", "statusName" : "READY", "url" : "https://api-backup.mongodb.com/backup/restore/v2/pull/{JOB-ID}/NWRlMTk4NzgxYzNjNDIzOTg2Yzc3YzkyODYxYjNjMzY=/electron_0-1492528465-{JOB-ID}.tar.gz" }, "encryptionEnabled" : false, "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" } ], "pointInTime" : false, "snapshotId" : "{SNAPSHOT-ID}", "statusName" : "FINISHED", "timestamp" : { "date" : "2017-04-19T21:14:25Z", "increment" : 1 } } ], "totalCount" : 2 }