Obter todos os trabalhos de restauração de um cluster

Nesta página

Recursos

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

O Cloud Manager não oferecerá mais suporte para Automação, Backup e Monitoramento do MongoDB 3.6 e 4.0 após 30 de agosto de 2024. Faça upgrade da sua versão do MongoDB ou migre para o Atlas.

A autenticação OAuth 2.0 para acesso programático ao Cloud Manager está disponível como um recurso de visualização.: O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para usar a 2.0 autenticação OAuth, crie uma conta de serviço para usar em suas solicitações para a API pública do Cloud Manager .

Obtenha todos os trabalhos de restauração para um cluster. CLUSTER-ID deve ser a ID de um conjunto de réplicas ou de um cluster fragmentado.

Observação

Se você utilizar o parâmetro de query do BATCH-ID , você poderá recuperar todos os trabalhos de restauração no lote especificado. Ao criar um tarefa de restauração para um cluster fragmentado, o Cloud Manager cria um tarefa separado para cada fragmento, além de outro para o servidor de configuração. Cada um desses trabalhos faz parte de um lote. No entanto, um tarefa de restauração para um conjunto de réplicas não pode fazer parte de um lote.

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

Recursos

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

GET /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs?batchId={BATCH-ID}

Parâmetros do caminho da solicitação

Nome	Tipo	Descrição
ID do projeto	string	Identificador exclusivo do projeto que possui o snapshot.
ID DE CLUSTER	string	Identificador exclusivo do cluster que o snapshot representa.

Solicitar parâmetros de query

Nome	Tipo	necessidade	Descrição	Default
pageNum	número	Opcional	Um inteiro baseado que retorna uma subseção de resultados.	`1`
itemsPerPage	número	Opcional	Número de itens a serem devolvidos por página, até um máximo de 500.	`100`
pretty	booleano	Opcional	Sinalizador que indica se o corpo da resposta deve estar em um prettyprint formato.	`false`
envelope	booleano	Opcional	Sinalizador que indica se deseja ou não envolver a resposta em um envelope. Alguns clientes do API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, configure `envelope : true` na consulta. Para endpoints que retornam uma lista de resultados, o objeto `content` é um envelope. O Cloud Manager adiciona o campo `status` ao corpo da resposta.	`false`
backupJobsEnabledOnly	booleano	Opcional	Sinalizador que indica se os daemon não habilitados para reconhecimento de data center devem ser excluídos da resposta. Defina isso como `false` para incluir configurações de daemon com o sinalizador `backupJobsEnabled` definido como `false`.	`true`

lote-ID	string	Identificador único do lote.	`NONE`

Parâmetros do corpo da solicitação

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

Resposta

documento de resposta

O documento JSON de resposta inclui uma array de objetos result , uma array de objetos link e uma contagem do número total de objetos result recuperados.

Nome	Tipo	Descrição
`results`	array	A array inclui um objeto para cada item detalhado na seção Documento incorporado`results` .
`links`	array	A array inclui um ou mais links para sub-recursos e/ou recursos relacionados. As relações entre URLs são explicadas na Especificação de links da web.
`totalCount`	número	Contagem de números inteiros do número total de itens no conjunto de resultados. Pode ser maior que o número de objetos na array results se todo o conjunto de resultados for paginado.

`results` documento incorporado

Cada resultado é uma tarefa de restauração de cluster.

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?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

{
  "links" : [ {
    "href" : "https://cloud.mongodb.com/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" : "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}",
    "id" : "{JOB-ID}",
    "links" : [ {
      "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs/{JOB-ID}",
      "rel" : "self"
    } ],
    "snapshotId" : "{SNAPSHOT-ID}",
    "statusName" : "FINISHED",
    "timestamp" : {
      "date" : "2017-04-18T15:14:25Z",
      "increment" : 1
    }
  }, {
    "batchId" : "{BATCH-ID}",
    "clusterId" : "{CLUSTER-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}",
    "id" : "{JOB-ID}",
    "links" : [ {
      "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/restoreJobs/{JOB-ID}",
      "rel" : "self"
    } ],
    "snapshotId" : "{SNAPSHOT-ID}",
    "statusName" : "FINISHED",
    "timestamp" : {
      "date" : "2017-04-19T21:14:25Z",
      "increment" : 1
    }
  } ],
  "totalCount" : 2
}

Voltar

Restaurar trabalhos

Obter um (cluster)