Criar 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
documento de resposta
results documento incorporado
Exemplo de solicitação
Exemplos de respostas
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}/clusters/{CLUSTER-ID}/restoreJobs

Parâmetros do caminho da solicitação

Nome	Tipo	Descrição
`PROJECT-ID`	string	Identificador único do projeto que possui a tarefa.
`CLUSTER-ID`	string	Identificador único do cluster que a tarefa 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 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

Nome	Tipo	necessidade	Descrição
`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. Se você definir `delivery.expires`, você não poderá definir `delivery.expirationHours`.
`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. Se você definir `delivery.expirationHours`, você não poderá definir `delivery.expires`.
`delivery` `.maxDownloads`	número	Obrigatório	Número de vezes que o URL de download pode ser usado. Deve ser `1` ou superior.
`delivery` `.methodName`	string	Obrigatório	Significa pelo qual o Cloud Manager fornece os dados. Defina como `HTTP`.
`snapshotId`	string	Obrigatório	Identificador exclusivo do snapshot a ser restaurado.

Observação

Condição

Se você definir "delivery.methodName" : AUTOMATED_RESTORE", deverá definir delivery.targetGroupId e delivery.targetClusterId.

Crie uma restauração automatizada a partir de um snapshot.

Nome	Tipo	necessidade	Descrição
`delivery`	objeto	Obrigatório	Método e detalhes de como os dados de snapshot restaurados são entregues.
`delivery` `.methodName`	string	Obrigatório	Significa pelo qual o Cloud Manager fornece os dados. Defina como `AUTOMATED_RESTORE`. A resposta mostra o `"delivery.methodName" : "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	Obrigatório	Identificador único do cluster de destino. Use o `clusterId` retornado no corpo da resposta dos endpoints Get All Snapshots e Get a Snapshot . 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	Obrigatório	Identificador único do projeto que contém o cluster de destino da tarefa de restauração.
`snapshotId`	string	Obrigatório	Identificador exclusivo do snapshot a ser restaurado.

Crie uma restauração automatizada a partir de um carimbo de data/hora oplog .

oplog As Restaurações oplog funcionam com Conjuntos de Réplicas usando qualquer versão do MongoDB ou Clusters Fragmentados usando FCV 4.2 ou posterior.

Nome	Tipo	necessidade	Descrição
`delivery`	objeto	Obrigatório	Método e detalhes de como os dados de snapshot restaurados são entregues.
`delivery` `.methodName`	string	Obrigatório	Significa pelo qual o Cloud Manager fornece os dados. Defina como `AUTOMATED_RESTORE`. A resposta mostra o `"delivery.methodName" : "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	Obrigatório	Identificador único do cluster de destino. Use o `clusterId` retornado no corpo da resposta dos endpoints Get All Snapshots e Get a Snapshot . 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	Obrigatório	Identificador único do projeto que contém o cluster de destino da tarefa de restauração.
`oplogTs`	string	Obrigatório	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. 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	Obrigatório	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. 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` .

Crie uma restauração automatizada a partir de um ponto específico.

As Restaurações PIT funcionam com Conjuntos de Réplicas usando qualquer versão do MongoDB ou Clusters Fragmentados usando FCV 4.2 ou posterior.

Nome	Tipo	necessidade	Descrição
`delivery`	objeto	Obrigatório	Método e detalhes de como os dados de snapshot restaurados são entregues.
`delivery` `.methodName`	string	Obrigatório	Significa pelo qual o Cloud Manager fornece os dados. Defina como `AUTOMATED_RESTORE`. A resposta mostra o `"delivery.methodName" : "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	Obrigatório	Identificador único do cluster de destino. Use o `clusterId` retornado no corpo da resposta dos endpoints Get All Snapshots e Get a Snapshot . 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	Obrigatório	Identificador único do projeto que contém o cluster de destino da tarefa de restauração.
`pointInTimeUTCMillis`	long	Obrigatório	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` .

Crie uma restauração automatizada a partir de um checkpoint}. O ponto de verificação restaura o trabalho para clusters fragmentados que executam clusters MongoDB com FCV 4.0 ou anterior.

Importante

Não use restaurações de checkpoint de verificação para clusters MongoDB com FCV 4.2 ou posterior.

Nome	Tipo	necessidade	Descrição
`checkpointId`	string	Obrigatório	Identificador exclusivo do checkpoint do cluster fragmentado que representa o ponto no tempo para o qual seus dados serão restaurados. 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` `.methodName`	string	Obrigatório	Significa pelo qual o Cloud Manager fornece os dados. Defina como `AUTOMATED_RESTORE`. A resposta mostra o `"delivery.methodName" : "HTTP"`. Uma restauração automatizada usa o método `HTTP` para entregar a tarefa de restauração ao host de destino.
`delivery` `.targetClusterId`	string	Obrigatório	Identificador único do cluster de destino. Use o `clusterId` retornado no corpo da resposta dos endpoints Get All Snapshots e Get a Snapshot . 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	Obrigatório	Identificador único do projeto que contém o cluster de destino da tarefa de restauração.

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. Esta matriz inclui apenas uma tarefa de restauração.

Nome	Tipo	Descrição
`batchId`	string	Unique identifier of the batch to which this restore job belongs. Retornado se o snapshot fosse de um cluster fragmentado.
`clusterId`	string	Identificador único do cluster que o trabalho de restauração representa. Retornado se o snapshot for de um conjunto de réplicas ou cluster fragmentado.
`created`	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.
`delivery` `.expirationHours`	número	Número de horas em que o URL de download é válido após a conclusão do trabalho de restauração.
`delivery` `.expires`	string	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` `.maxDownloads`	número	Número de vezes que o URL de download pode ser usado. Deve ser `1` ou superior.
`delivery` `.methodName`	string	Significa pelo qual os dados são entregues. Retorna `HTTP`.
`delivery` `.statusName`	string	Status atual do arquivo para download. Os valores aceitos são: `NOT_STARTED` `IN_PROGRESS` `READY` `FAILED` `INTERRUPTED` `EXPIRED` `MAX_DOWNLOADS_EXCEEDED`
`delivery` `.url`	string	URL a partir da qual os dados de snapshot restaurados podem ser baixados.
`encryptionEnabled`	booleano	Sinalizador que indica se o snapshot foi criptografado.
`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, essa array retornará 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 retornado, o valor é definido como `SHA1`.
`hostId`	string	Identificador único do servidor de configuração ao qual pertence este tarefa de restauração. Retornado se o servidor de configuração for um SCCC.
`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.
`masterKeyUUID`	string	ID da chave mestra KMIP usada para criptografar os dados do snapshot . Retornado se `"encryptionEnabled" : true`.
`pointInTime`	booleano	Sinalizador que indica se o snapshot era de um ponto no tempo.
`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.

Nome	Tipo	Descrição
`batchId`	string	Unique identifier of the batch to which this restore job belongs. Retornado se o snapshot fosse de um cluster fragmentado.
`clusterId`	string	Identificador único do cluster que o trabalho de restauração representa. Retornado se o snapshot for de um conjunto de réplicas ou cluster fragmentado.
`created`	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.
`delivery` `.methodName`	string	Significa pelo qual os dados são entregues. Retorna `HTTP`.
`delivery` `.targetClusterId`	string	Identificador único do cluster de destino para executar o tarefa de restauração.
`delivery` `.targetGroupId`	string	Identificador único do projeto que contém o cluster de destino da tarefa de restauração.
`encryptionEnabled`	booleano	Sinalizador que indica se o snapshot foi criptografado.
`groupId`	string	Identificador exclusivo do grupo que possui o trabalho de restauração.
`hostId`	string	Identificador único do servidor de configuração ao qual pertence este tarefa de restauração. Retornado se o servidor de configuração for um SCCC.
`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.
`masterKeyUUID`	string	ID da chave mestra KMIP usada para criptografar os dados do snapshot . Retornado se `"encryptionEnabled" : true`.
`pointInTime`	booleano	Sinalizador que indica se o snapshot era de um ponto no tempo.
`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.

Nome	Tipo	Descrição
`batchId`	string	Unique identifier of the batch to which this restore job belongs. Retornado se o snapshot fosse de um cluster fragmentado.
`clusterId`	string	Identificador único do cluster que o trabalho de restauração representa. Retornado se o snapshot for de um conjunto de réplicas ou cluster fragmentado.
`created`	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.
`delivery` `.methodName`	string	Significa pelo qual os dados são entregues. Retorna `HTTP`.
`delivery` `.targetClusterId`	string	Identificador único do cluster de destino para executar o tarefa de restauração.
`delivery` `.targetGroupId`	string	Identificador único do projeto que contém o cluster de destino da tarefa de restauração.
`encryptionEnabled`	booleano	Sinalizador que indica se o snapshot foi criptografado.
`groupId`	string	Identificador exclusivo do grupo que possui o trabalho de restauração.
`hostId`	string	Identificador único do servidor de configuração ao qual pertence este tarefa de restauração. Retornado se o servidor de configuração for um SCCC.
`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.
`masterKeyUUID`	string	ID da chave mestra KMIP usada para criptografar os dados do snapshot . Retornado se `"encryptionEnabled" : true`.
`pointInTime`	booleano	Sinalizador que indica se o snapshot era de um ponto no tempo.
`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.

Nome	Tipo	Descrição
`batchId`	string	Unique identifier of the batch to which this restore job belongs. Retornado se o snapshot fosse de um cluster fragmentado.
`clusterId`	string	Identificador único do cluster que o trabalho de restauração representa. Retornado se o snapshot for de um conjunto de réplicas ou cluster fragmentado.
`created`	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.
`delivery` `.methodName`	string	Significa pelo qual os dados são entregues. Retorna `HTTP`.
`delivery` `.targetClusterId`	string	Identificador único do cluster de destino para executar o tarefa de restauração.
`delivery` `.targetGroupId`	string	Identificador único do projeto que contém o cluster de destino da tarefa de restauração.
`encryptionEnabled`	booleano	Sinalizador que indica se o snapshot foi criptografado.
`groupId`	string	Identificador exclusivo do grupo que possui o trabalho de restauração.
`hostId`	string	Identificador único do servidor de configuração ao qual pertence este tarefa de restauração. Retornado se o servidor de configuração for um SCCC.
`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.
`masterKeyUUID`	string	ID da chave mestra KMIP usada para criptografar os dados do snapshot . Retornado se `"encryptionEnabled" : true`.
`pointInTime`	booleano	Sinalizador que indica se o snapshot era de um ponto no tempo.
`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.

Nome	Tipo	Descrição
`batchId`	string	Unique identifier of the batch to which this restore job belongs. Retornado se o snapshot fosse de um cluster fragmentado.
`checkpointId`	string	Identificador exclusivo do checkpoint do cluster fragmentado que representa o ponto no tempo para o qual seus dados serão restaurados.
`clusterId`	string	Identificador único do cluster que o trabalho de restauração representa. Retornado se o snapshot for de um conjunto de réplicas ou cluster fragmentado.
`created`	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.
`delivery` `.methodName`	string	Significa pelo qual os dados são entregues. Retorna `HTTP`.
`delivery` `.targetClusterId`	string	Identificador único do cluster de destino para executar o tarefa de restauração.
`delivery` `.targetGroupId`	string	Identificador único do projeto que contém o cluster de destino da tarefa de restauração.
`encryptionEnabled`	booleano	Sinalizador que indica se o snapshot foi criptografado.
`groupId`	string	Identificador exclusivo do grupo que possui o trabalho de restauração.
`hostId`	string	Identificador único do servidor de configuração ao qual pertence este tarefa de restauração. Retornado se o servidor de configuração for um SCCC.
`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.
`masterKeyUUID`	string	ID da chave mestra KMIP usada para criptografar os dados do snapshot . Retornado se `"encryptionEnabled" : true`.
`pointInTime`	booleano	Sinalizador que indica se o snapshot era de um ponto no tempo.
`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}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true" \
  --data '
   {
     "delivery" : {
       "expirationHours" : "1",
       "maxDownloads" : "1",
       "methodName" : "HTTP"
     },
     "snapshotId" : "{SNAPSHOT-ID}"
   }'

Crie uma restauração automatizada a partir de um snapshot.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --request POST "https://cloud.mongodb.com/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}"
       }'

Crie uma restauração automatizada a partir de um carimbo de data/hora oplog .

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}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true" \
  --data '
   {
     "delivery" : {
       "methodName" : "AUTOMATED_RESTORE",
       "targetGroupId" : "{TARGET-PROJECT-ID}",
       "targetClusterId" : "{TARGET-CLUSTER-ID}"
     },
     "oplogTs" : "1536610288",
     "oplogInc" : "1"
   }'

Crie uma restauração automatizada a partir de um ponto específico.

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}/clusters/{CLUSTER-ID}/restoreJobs?pretty=true" \
  --data '
   {
     "delivery" : {
       "methodName" : "AUTOMATED_RESTORE",
       "targetGroupId" : "{TARGET-PROJECT-ID}",
       "targetClusterId" : "{TARGET-CLUSTER-ID}"
     },
     "pointInTimeUTCMillis" : "1536610288000"
   }'

Crie uma restauração automatizada a partir de um checkpoint}. Válido apenas para clusters fragmentados que executam clusters MongoDB com FCV 4.0 ou anterior.

Importante

Não use restaurações de checkpoint de verificação para clusters MongoDB com FCV 4.2 ou posterior.

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}"
     },
     "checkpointId" : "{CHECKPOINT-ID}"
   }'

Exemplos de respostas

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": "2018-09-20T15:00:00Z",
    "delivery": {
      "expirationHours": 1,
      "maxDownloads": 1,
      "methodName": "HTTP",
      "statusName": "READY"
    },
    "encryptionEnabled": false,
    "groupId": "{PROJECT-ID}",
    "id": "{RESTORE-JOB-ID}",
    "links": [{
      "href": "https://cloud.mongodb.com/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://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" : "2020-04-21T03:49:57Z",
    "delivery" : {
      "expirationHours" : 1,
      "expires" : "2020-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" : "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://cloud.mongodb.com/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://cloud.mongodb.com/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://cloud.mongodb.com/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
}

Voltar

Obter um (cluster)

Obter todos (servidor de configuração)

Resource

Parâmetros do caminho da solicitação

Solicitar parâmetros de query

Parâmetros do corpo da solicitação

Observação

Condição

Importante

Resposta

documento de resposta

results documento incorporado

Exemplo de solicitação

Importante

Exemplos de respostas

Cabeçalho de resposta

Corpo de resposta

`results` documento incorporado