Restaurar um snapshot de uma instância sem servidor Obsoleto(a)

POSTAR /api/atlas/v1.0/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs

Restaura um snapshot de uma instância sem servidor do projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de proprietário do projeto.

Essa API também pode ser usada em clusters Flex que foram criados com o ponto de extremidade Create Serverless Instance ou clusters Flex que foram migrados de instâncias sem servidor. Esse ponto de extremidade será colocado no sol em 22 de janeiro de 2026. Em vez disso, use o ponto de extremidade Criar tarefa de restaurar backup flexível.

criarTarefaDeBackupERestauraçãoFlexível

parâmetros de caminho

  • groupId string Obrigatório

    Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso.

    AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos.

    O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

  • clusterName string Obrigatório

    Rótulo legível por humanos que identifica a instância sem servidor cujo snapshot você deseja restaurar.

    O formato deve corresponder ao seguinte padrão: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.

parâmetros de query

  • envelope booleano

    Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON 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 consulta. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta.

    O valor padrão é false.

  • pretty booleano

    Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

    O valor padrão é false.

    Prettyprint
aplicação/json

corpo, corpo Obrigatório

Restaura um snapshot de uma instância sem servidor do projeto especificado.

  • deliveryType string Obrigatório

    Rótulo legível por humanos que categoriza a tarefa de restauração a ser criada.

    Os valores são automated, download ou pointInTime.

  • oplogInc integer(int32)

    Número de operação Oplog da qual você deseja restaurar esse snapshot. Esse número representa a segunda parte de um carimbo de data/hora Oplog. O recurso retorna esse parâmetro quando "deliveryType" : "pointInTime" e oplogTs ultrapassam 0.

    O valor mínimo é 1.

  • oplogTs integer(int32)

    Data e hora a partir das quais você deseja restaurar esse snapshot. Esse parâmetro expressa este carimbo de data/hora no número de segundos decorridos desde a Era UNIX. Esse número representa a primeira parte de um carimbo de data/hora Oplog. O recurso retorna esse parâmetro quando "deliveryType" : "pointInTime" e oplogTs ultrapassam 0.

    O valor mínimo é 1199145600.

  • pointInTimeUTCSeconds integer(int32)

    Data e hora em que a nuvem do MongoDB Cloud restaurou esse snapshot. Esse parâmetro expressa este carimbo de data/hora no número de segundos decorridos desde a Era UNIX. O recurso retorna esse parâmetro quando "deliveryType" : "pointInTime" e pointInTimeUTCSeconds ultrapassam 0.

    O valor mínimo é 1199145600.

  • snapshotId string

    String exclusiva de 24 caracteres hexadecimais que identifica o snapshot.

    O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

  • targetClusterName string Obrigatório

    Etiqueta legível para humanos que identifica o cluster de destino no qual a tarefa de restauração restaura o snapshot. O recurso retorna este parâmetro quando "deliveryType": "automated".

    O formato deve corresponder ao seguinte padrão: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.

  • targetGroupId string Obrigatório

    String única de 24dígitos hexadecimais que identifica o projeto de destino para o targetClusterName especificado.

    O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

Respostas

  • 200 aplicação/json

    OK

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • cancelado booleano

      Sinalizador que indica se alguém cancelou esta tarefa de restauração.

    • deliveryType string Obrigatório

      Rótulo legível por humanos que categoriza a tarefa de restauração a ser criada.

      Os valores são automated, download ou pointInTime.

    • deliveryUrl array[string]

      Um ou mais localizadores uniformes de recursos (URLs) que ponto para os arquivos de snapshot compactados para download manual. O MongoDB Cloud retorna esse parâmetro quando "deliveryType" : "download".

    • desejarTimestamp objeto

      Carimbo de data/hora JSON que indica quando ocorreu a entrada do token de checkpoint no oplog.

      Ocultar atributos desejadoTimestamp Mostrar atributos desejadoTimestamp objeto
      • data string(data-hora)

        Data e hora em que o oplog registrou essa operação de banco de dados . Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

      • Incremento integer(int32)

        Ordem da operação do banco de dados que o oplog registrou em data e hora específicas.

        O valor mínimo é 1199145600.

    • expirado booleano

      Sinalizador que indica se a tarefa de restauração expirou.

    • expiresAt string(data-hora)

      Data e hora em que o tarefa de restauração expira. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

    • Falhou booleano

      Sinalizador que indica se o tarefa de restauração falhou.

    • completedAt string(data-hora)

      Data e hora em que o tarefa de restauração foi concluído. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

    • id string

      String única de 24caracteres hexadecimais que identifica a tarefa de restauração.

      O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

    • oplogInc integer(int32)

      Número de operação Oplog da qual você deseja restaurar esse snapshot. Esse número representa a segunda parte de um carimbo de data/hora Oplog. O recurso retorna esse parâmetro quando "deliveryType" : "pointInTime" e oplogTs ultrapassam 0.

      O valor mínimo é 1.

    • oplogTs integer(int32)

      Data e hora a partir das quais você deseja restaurar esse snapshot. Esse parâmetro expressa este carimbo de data/hora no número de segundos decorridos desde a Era UNIX. Esse número representa a primeira parte de um carimbo de data/hora Oplog. O recurso retorna esse parâmetro quando "deliveryType" : "pointInTime" e oplogTs ultrapassam 0.

      O valor mínimo é 1199145600.

    • pointInTimeUTCSeconds integer(int32)

      Data e hora em que a nuvem do MongoDB Cloud restaurou esse snapshot. Esse parâmetro expressa este carimbo de data/hora no número de segundos decorridos desde a Era UNIX. O recurso retorna esse parâmetro quando "deliveryType" : "pointInTime" e pointInTimeUTCSeconds ultrapassam 0.

      O valor mínimo é 1199145600.

    • snapshotId string

      String exclusiva de 24 caracteres hexadecimais que identifica o snapshot.

      O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

    • targetClusterName string Obrigatório

      Etiqueta legível para humanos que identifica o cluster de destino no qual a tarefa de restauração restaura o snapshot. O recurso retorna este parâmetro quando "deliveryType": "automated".

      O formato deve corresponder ao seguinte padrão: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.

    • targetGroupId string Obrigatório

      String única de 24dígitos hexadecimais que identifica o projeto de destino para o targetClusterName especificado.

      O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

    • timestamp string(data-hora)

      Data e hora em que o MongoDB nuvem tirou o snapshot associado a snapshotId. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

  • 400 aplicação/json

    Solicitação inválida.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

  • 401 aplicação/json

    Não autorizado.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

  • 403 aplicação/json

    Forbidden.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

  • 404 aplicação/json

    Não encontrado.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

  • 409 aplicação/json

    Conflito.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

  • 500 aplicação/json

    Erro interno do servidor.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

POST /API/atlas/v1.0/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs
curl \
 --request POST 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/serverless/{clusterName}/backup/restoreJobs' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"deliveryType":"automated","oplogInc":1,"oplogTs":42,"pointInTimeUTCSeconds":42,"snapshotId":"32b6e34b3d91647abb20e7b8","targetClusterName":"string","targetGroupId":"32b6e34b3d91647abb20e7b8"}'
Exemplos de solicitação
{
  "deliveryType": "automated",
  "oplogInc": 1,
  "oplogTs": 42,
  "pointInTimeUTCSeconds": 42,
  "snapshotId": "32b6e34b3d91647abb20e7b8",
  "targetClusterName": "string",
  "targetGroupId": "32b6e34b3d91647abb20e7b8"
}
Exemplos de resposta (200)
{
  "cancelled": true,
  "deliveryType": "automated",
  "deliveryUrl": [
    "string"
  ],
  "desiredTimestamp": {
    "date": "2026-05-04T09:42:00Z",
    "increment": 1199145600
  },
  "expired": true,
  "expiresAt": "2026-05-04T09:42:00Z",
  "failed": true,
  "finishedAt": "2026-05-04T09:42:00Z",
  "id": "32b6e34b3d91647abb20e7b8",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "oplogInc": 1,
  "oplogTs": 42,
  "pointInTimeUTCSeconds": 42,
  "snapshotId": "32b6e34b3d91647abb20e7b8",
  "targetClusterName": "string",
  "targetGroupId": "32b6e34b3d91647abb20e7b8",
  "timestamp": "2026-05-04T09:42:00Z"
}
Exemplos de resposta (400)
{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}
Exemplos de resposta (401)
{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}
Exemplos de resposta (403)
{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
Exemplos de resposta (404)
{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}
Exemplos de resposta (409)
{
  "error": 409,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
  "reason": "Conflict",
  "errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}
Exemplos de resposta (500)
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}