Atualizar data de validade de um snapshot de backup legado Obsoleto(a)

REMENDO /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}

Altera a data de validade de um snapshot de backup legado para um cluster no 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. A partir de 23 de março de 2020, todos os novos clusters podem usar apenas backups em nuvem. Quando você faz upgrade para 4.2, seu sistema de backup faz upgrade para o backup em nuvem, caso esteja atualmente definido como backup legado. Após fazer o upgrade, todos os seus snapshots de backup legados existentes permanecerão disponíveis. Eles expiram ao longo do tempo de acordo com sua política de retenção. Sua política de backup é redefinida para o agendamento padrão. Se você tinha uma política de backup personalizada em vigor com backups legados, você deve recriá-la com o procedimento descrito na documentação de backups em nuvem.

Documentação de backups em nuvem

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

    Etiqueta legível por humanos que identifica o cluster.

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

  • snapshotId string Obrigatório

    String única de 24 dígitos hexadecimais que identifica o snapshot desejado.

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

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
application/vnd.atlas.2023-01-01+json

corpo, corpo Obrigatório

Altera a expiração de um snapshot de backup legado.

  • doNotDelete booleano

    Sinalizador que indica se alguém pode excluir esse snapshot. Não é possível definir "doNotDelete" : true e definir um registro de data e hora com expiração na mesma solicitação.

  • expira string(data-hora)

    Data e hora em que o MongoDB Cloud exclui o snapshot. Se "doNotDelete" : true, o MongoDB Cloud removerá qualquer valor definido para este parâmetro. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

Respostas

  • 200 application/vnd.atlas.2023-01-01+json

    OK

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • clusterId string

      String única de 24dígitos hexadecimais que identifica o cluster com os snapshots que você deseja retornar.

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

    • clusterName string

      Etiqueta legível por humanos que identifica o cluster.

    • completo booleano

      Sinalizador que indica se o snapshot existe. Esse sinalizador retorna false enquanto o MongoDB Cloud cria o snapshot.

    • Criado objeto

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

      Ocultar atributos criados Mostrar atributos criados 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.

    • doNotDelete booleano

      Sinalizador que indica se alguém pode excluir esse snapshot. Não é possível definir "doNotDelete" : true e definir um registro de data e hora com expiração na mesma solicitação.

    • expira string(data-hora)

      Data e hora em que o MongoDB Cloud exclui o snapshot. Se "doNotDelete" : true, o MongoDB Cloud removerá qualquer valor definido para este parâmetro. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

    • groupId string

      String única de 24dígitos hexadecimais que identifica o projeto que possui os snapshots.

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

    • id string

      String única de 24dígitos hexadecimais que identifica o snapshot.

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

    • incremental booleano

      Sinalizador que indica se este é um snapshot incremental ou completo.

    • lastOplogAppliedTimestamp objeto

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

      Ocultar atributos lastOplogAppliedTimestamp Mostrar atributos lastOplogAppliedTimestamp 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.

    • peças array[objeto]

      Metadados que descrevem o snapshot completo.

      • Para um conjunto de réplicas, essa array contém um único documento.
      • Para um cluster fragmentado, essa array contém um documento para cada fragmento e um documento para o host de configuração.

      Características que identificam esse snapshot.

      Ocultar atributos das peças Mostrar atributos das peças objeto
      • clusterId string

        String única de 24dígitos hexadecimais que identifica o cluster com os snapshots que você deseja retornar.

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

      • completedTime string(data-hora)

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

      • compressorSetting string

        Rótulo legível por humanos que identifica o método de compactação do snapshot.

        Os valores são NONE ou GZIP.

      • dataSizeBytes integer(int64)

        Tamanho total dos dados armazenados em cada nó do cluster. Este parâmetro expressa seu valor em bytes.

      • encryptionEnabled booleano

        Sinalizador que indica se alguém criptografou esse snapshot.

      • fcv string

        Número que indica a versão de compatibilidade do recurso do MongoDB que o conjunto de réplicas primary executou quando o MongoDB Cloud criou o snapshot.

      • fileSizeBytes integer(int64)

        Número que indica o tamanho total dos arquivos de dados em bytes.

      • machineId string

        Nome do host e porta que indicam o nó no qual o MongoDB Cloud criou o snapshot.

        O formato deve corresponder ao seguinte padrão: ^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?(\:[0-9]{4,5})$.

      • masterKeyUUID string(uuid)

        String exclusiva que identifica a chave mestra KMIP (Interoperabilidade de Gerenciamento de Chaves) usada para criptografar os dados de snapshot. O recurso retorna este parâmetro quando "parts.encryptionEnabled" : true.

      • mongodVersion string

        Número que indica a versão do MongoDB que o conjunto de réplicas primary executou quando o MongoDB Cloud criou o snapshot.

        O formato deve corresponder ao seguinte padrão: ([\d]+\.[\d]+\.[\d]+).

      • ReplicaSetName string

        Etiqueta legível por humanos que identifica o conjunto de réplicas.

      • estado da réplica string

        A função do nó no momento em que o processo de snapshot começou.

      • storageSizeBytes integer(int64)

        Número que indica o tamanho total do espaço alocado para armazenamento de documento .

      • typeName string

        Etiqueta legível por humanos que identifica o tipo de servidor do qual o MongoDB Cloud tirou esse snapshot.

        Os valores são REPLICA_SET, CONFIG_SERVER, CONFIG_SERVER_REPLICA_SET ou CONFIG_SHARD_REPLICA_SET.

  • 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.

  • 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.

PATCH /API/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}
atlas api legacyBackup updateGroupClusterSnapshot --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.UpdateGroupClusterSnapshotApiParams{}
	sdkResp, httpResp, err := client.LegacyBackupApi.
		UpdateGroupClusterSnapshotWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" \
  -d '{ <Payload> }'
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  --header "Content-Type: application/json" \
  -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}" \
  -d '{ <Payload> }'
Exemplos de solicitação
{
  "doNotDelete": true,
  "expires": "2025-05-04T09:42:00Z"
}
Exemplos de resposta (200)
{
  "clusterId": "32b6e34b3d91647abb20e7b8",
  "clusterName": "string",
  "complete": true,
  "created": {
    "date": "2025-05-04T09:42:00Z",
    "increment": 1199145600
  },
  "doNotDelete": true,
  "expires": "2025-05-04T09:42:00Z",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "incremental": true,
  "lastOplogAppliedTimestamp": {
    "date": "2025-05-04T09:42:00Z",
    "increment": 1199145600
  },
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "parts": [
    {
      "clusterId": "32b6e34b3d91647abb20e7b8",
      "completedTime": "2025-05-04T09:42:00Z",
      "compressionSetting": "NONE",
      "dataSizeBytes": 42,
      "encryptionEnabled": true,
      "fcv": "string",
      "fileSizeBytes": 42,
      "machineId": "string",
      "masterKeyUUID": "string",
      "mongodVersion": "string",
      "replicaSetName": "string",
      "replicaState": "string",
      "storageSizeBytes": 42,
      "typeName": "REPLICA_SET"
    }
  ]
}
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 (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"
}