Menu Docs
Página inicial do Docs
/
MongoDB Cloud Manager
/
API
/
Recursos
/
Backup e restauração
/
Restaurar trabalhos

Obter uma tarefa de restauração para um cluster

Nesta página

  • Resource
  • Parâmetros do caminho da solicitação
  • Solicitar parâmetros de query
  • Parâmetros do corpo da solicitação
  • Resposta
  • Exemplo de solicitação
  • Exemplo de resposta
  • Cabeçalho de resposta
  • Corpo de resposta

URL base: https://cloud.mongodb.com/api/public/v1.0

Resource

GET /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs/{JOB-ID}

Parâmetros do caminho da solicitação

Nome
Tipo
Descrição
ID do projeto
string
Identificador único do projeto que possui o trabalho de restauração.
ID DE CLUSTER
string
Identificador único do cluster que a tarefa de restauração representa.
tarefa-ID
string
Identificador único da tarefa de restauração.

Solicitar parâmetros de query

Os seguintes parâmetros de query são opcionais:

Nome
Tipo
necessidade
Descrição
Default
pretty
booleano
Opcional
false
envelope
booleano
Opcional

Sinalizador que indica se deseja ou não envolver a resposta em um envelope.

Alguns clientes da API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query.

Para endpoints que retornam um resultado, o corpo da resposta inclui:

Nome
Descrição
status
Código de resposta HTTP
content
Corpo de resposta esperado
false

Parâmetros do corpo da solicitação

Este endpoint não usa parâmetros do corpo da solicitação HTTP.

Resposta

Nome
Tipo
Descrição
batchId
string
Condicional: cluster fragmentado . Identificador único do lote ao qual pertence este tarefa de restauração.
clusterId
string
Condicional: apenas cluster . Identificador único do cluster que o trabalho de restauração representa.
Criado
string
Carimbo de data/hora na ISO 8601 formato de data e hora em UTC quando a tarefa de restauração foi solicitada.
delivery
objeto
Método e detalhes de como os dados de snapshot restaurados são entregues.
entrega.expirationHours
número
Condicional: "delivery.methodName" : "HTTP". Número de horas em que a URL de download é válida após a conclusão do tarefa de restauração.
delivery.expires
string
Condicional: "delivery.methodName" : "HTTP". Carimbo de data/hora na ISO 8601 formato de data e hora em UTC após o qual a URL não está mais disponível.
entrega.maxDownloads
número
Condicional: "delivery.methodName" : "HTTP". Número de vezes que o URL de download pode ser usado. Deve ser 1 ou superior.
entrega.methodName
string

Significa pelo qual os dados são entregues. Os valores aceitos são:

  • HTTP

IMPORTANTE: a restauração da entrega via SCP foi removida de março de 27 2018.

entrega.statusName
string

Status atual do arquivo para download. Os valores aceitos são:

  • NOT_STARTED

  • IN_PROGRESS

  • READY

  • FAILED

  • INTERRUPTED

  • EXPIRED

  • MAX_DOWNLOADS_EXCEEDED

entrega.url
string
Condicional: "delivery.methodName" : "HTTP". URL a partir da qual os dados de snapshot restaurados podem ser baixados.
groupId
string
Identificador exclusivo do grupo que possui o trabalho de restauração.
hashes
array de objetos

Se o delivery.url correspondente tiver sido baixado, cada documento nessa array será um mapeamento de um arquivo de restauração para uma soma de verificação com hash. Essa array está presente somente após o download do arquivo.

Para uma restauração do HTTP , esta array contém somente um único objeto que representa o hash do arquivo .tar.gz .

hashes.fileName
string
Nome do arquivo de snapshot que foi criptografado.
hashes.hash
string
Hash do arquivo de snapshot.
hashes.typeName
string
Algoritmo de hash usado para calcular o valor de hash. Se estiver presente, esse valor é SHA1.
hostId
string
Condicional: servidor de configuração espelhado (SCCC). Identificador único do servidor de configuração ao qual pertence este trabalho de restauração.
id
string
Identificador único da tarefa de restauração.
links
array de objetos

Um ou mais links para sub-recursos e/ou recursos relacionados. Todas as arrays links nas respostas incluem pelo menos um link chamado self. Os relacionamentos entre URLs são explicados na Especificação de links da web.

pointInTime
booleano
Sinalizador que indica que a tarefa é de uma restauração de PIT .
snapshotId
string
Identificador exclusivo do snapshot a ser restaurado.
statusName
string

Status atual da tarefa. Os valores aceitos são:

  • FINISHED

  • IN_PROGRESS

  • BROKEN

  • KILLED

timestamp
objeto
Carimbo de data/hora da entrada oplog em que o snapshot foi criado.
timestamp.date
string
Carimbo de data/hora na ISO 8601 formato de data e hora em UTC da entrada de oplog mais recente no snapshot restaurado.
timestamp.increment
string
Ordem de todas as operações concluídas na última entrada de oplog no snapshot restaurado.

Exemplo de solicitação

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}/clusters/{CLUSTER-ID}/restoreJobs/{JOB-ID}?pretty=true"

Exemplo de resposta

Cabeçalho de resposta

HTTP/1.1 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
HTTP/1.1 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}

Corpo de resposta

{
  "batchId" : "{BATCH-ID}",
  "clusterId" : "{CLUSTER-ID}",
  "created" : "2016-03-04T22:07:27Z",
  "delivery" : {
    "expirationHours" : 1,
    "expires" : "2016-03-04T23:07:27Z",
    "maxDownloads" : 1,
    "methodName" : "HTTP",
    "statusName" : "EXPIRED",
    "url" : "https://api-backup.mongodb.com/backup/restore/v2/pull/{JOB-ID}/1976673072885966399/electron_0-1456098690-{JOB-ID}.tar.gz"
  },
  "encryptionEnabled" : false,
  "groupId" : "{PROJECT-ID}",
  "id" : "{JOB-ID}",
  "links" : [ {
  } ],
  "pointInTime" : false,
  "snapshotId" : "{SNAPSHOT-ID}",
  "statusName" : "FINISHED",
  "timestamp" : {
    "date" : "2017-04-19T21:14:25Z",
    "increment" : 1
  }
}

Voltar

Obter todos (cluster)

Próximo

Criar (Cluster)