Criar uma tarefa de restauração para um servidor de configuração espelhado legado

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

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 .

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

Resource

POST /groups/{PROJECT-ID}/hosts/{HOST-ID}/restoreJobs

Parâmetros do caminho da solicitação

Nome	Tipo	Descrição
ID do projeto	string	Identificador exclusivo do projeto que possui a tarefa.
ID DE HOST	string	Identificador exclusivo do servidor de configuração espelhada (SCCC) que o trabalho representa.

Solicitar parâmetros de query

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

Nome

Tipo

necessidade

Descrição

Default

pretty

booleano

Opcional

Sinalizador indicando 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 de 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

Nome	Tipo	necessidade	Descrição
`checkpointId`	string	Condicional	Identificador exclusivo do checkpoint do cluster fragmentado que representa o ponto no tempo para o qual seus dados serão restaurados. Condições: Defina `"delivery.methodName" : "AUTOMATED_RESTORE"`. Execute clusters fragmentados usando `FCV` 4.0 ou anterior. Não é possível definir `oplogInc`, `oplogTs` ou `pointInTimeUTCMillis`. Se você fornecer esta configuração, este endpoint restaurará todos os dados até este ponto de verificação para o banco de dados especificado no objeto `delivery` .
`delivery`	objeto	Obrigatório	Método e detalhes de como os dados de snapshot restaurados são entregues.
`delivery` `.expires`	string	Condicional	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. `delivery.methodName" : "HTTP"`
`delivery` `.expirationHours`	número	Condicional	Número de horas em que o URL de download é válido após a conclusão do trabalho de restauração. `delivery.methodName" : "HTTP"`
`delivery` `.maxDownloads`	número	Condicional	Número de vezes que o URL de download pode ser usado. Deve ser `1` ou superior. `delivery.methodName" : "HTTP"`
`delivery` `.methodName`	string	Obrigatório	Método pelo qual o Cloud Manager fornece os dados. Os valores aceitos são: `AUTOMATED_RESTORE` `HTTP` Se você definir `"delivery.methodName" : "AUTOMATED_RESTORE"`, você também deverá definir: `delivery.targetGroupId` e a `delivery.targetClusterId` Além disso, a resposta mostra o `delivery.methodName` como `HTTP`. Uma restauração automatizada usa o método `HTTP` para entregar a tarefa de restauração ao host de destino. IMPORTANTE: a restauração da entrega via SCP foi removida de março de 27 2018.
`delivery` `.targetClusterId`	string	Condicional	Identificador único do cluster de destino. Use o `clusterId` retornado no corpo da resposta dos endpoints Get All Snapshots e Get a Snapshot . `delivery.methodName" : "AUTOMATED_RESTORE"`. Se o backup não estiver habilitado no cluster de destino, o endpoint Get All Snapshots retornará uma array `results` vazia sem elementos `clusterId` e o endpoint Get a Snapshot também não retornará um elemento `clusterId` .
`delivery` `.targetGroupId`	string	Condicional	Identificador único do projeto que contém o cluster de destino da tarefa de restauração. `delivery.methodName" : "AUTOMATED_RESTORE"`
`oplogTs`	string	Condicional	oplog carimbo de data/hora fornecido como Registro de data/hora no número de segundos decorridos desde a UNIX epoch. Quando emparelhados com `oplogInc`, eles representam o ponto no tempo para o qual seus dados serão restaurados. Execute uma query em `local.oplog.rs` no seu conjunto de réplicas para encontrar o carimbo de data/hora desejado. `"delivery.methodName" : "AUTOMATED_RESTORE"` apenas para conjuntos de réplicas. Se você definir `oplogTs`, você: Deve definir `oplogInc`. Não é possível definir `checkpointId` ou `pointInTimeUTCMillis`. Se você fornecer essa configuração, esse endpoint restaurará todos os dados até e incluindo este carimbo de data/hora oplog no reconhecimento de data center especificado no objeto `delivery` .
`oplogInc`	string	Condicional	Ordinal incrementado de 32 bits que representa operações em um determinado segundo. Quando emparelhados com `oplogTs`, eles representam o ponto no tempo para o qual seus dados serão restaurados. `"delivery.methodName" : "AUTOMATED_RESTORE"` apenas para conjuntos de réplicas. Se você definir `oplogInc`, você: Deve definir `oplogTs`. Não é possível definir `checkpointId` ou `pointInTimeUTCMillis`. Se você fornecer essa configuração, esse endpoint restaurará todos os dados até e incluindo este carimbo de data/hora oplog no reconhecimento de data center especificado no objeto `delivery` .
`pointInTimeUTCMillis`	long	Condicional	carimbo de data/hora no número de milissegundos decorridos desde a UNIX epoch ', que representa o ponto no tempo para o qual seus dados serão restaurados. Esse carimbo de data/hora deve estar dentro das últimas 24 horas da hora atual. Se você fornecer essa configuração, esse endpoint restaurará todos os dados até esse momento específico no banco de dados especificado no objeto `delivery` . `"delivery.methodName" : "AUTOMATED_RESTORE"` apenas para conjuntos de réplicas. Se você definir `pointInTimeUTCMillis`, não poderá definir `oplogInc`, `oplogTs` ou `checkpointId`.
`snapshotId`	string	Condicional	Identificador exclusivo do snapshot a ser restaurado.

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. O valor aceito é `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.targetClusterId	string	Condicional: `delivery.methodName" : "AUTOMATED_RESTORE"`. Identificador único do cluster de destino para executar o tarefa de restauração.
entrega.targetGroupId	string	Condicional: `delivery.methodName" : "AUTOMATED_RESTORE"`. Identificador exclusivo do projeto que contém o cluster de destino para o tarefa de restauração.
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.
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

Crie um trabalho de restauração que transfira um snapshot compactado usando 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}"
      }'

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

{
  "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"
}

Voltar

Obtenha um (servidor de configuração)

Automação