Menu Docs
Página inicial do Docs
/ /
Atlas CLI
/ / / /

Atlas backups exports tarefa criar

Nesta página

  • Sintaxe
  • Opções
  • Opções herdadas
  • Saída
  • Exemplos

Exporte um snapshot de backup para um cluster do Atlas M10 ou superior para um bucket Amazon Web Services S3 existente.

Para usar esse comando, você deve se autenticar com uma conta de usuário ou uma chave de API com a role de proprietário do projeto.

Sintaxe do comando
atlas backups exports jobs create [options]
Nome
Tipo
Obrigatório
Descrição

--bucketId

string

true

Identificador único que o Atlas atribui ao bucket.

--clusterName

string

true

Nome do cluster.

--customData

chave=valor

false

Dados personalizados a serem incluídos no arquivo de metadados chamado .complete que o Atlas carrega no bucket quando a tarefa de exportação termina. Os dados personalizados podem ser especificados como pares de chave e valor.

-h, --help

false

ajuda para criar

-o, --output

string

false

Formato de saída. Os valores válidos são JSON, json-path, go-template ou go-template-file. Para ver o resultado completo, use a opção -o JSON.

--projectId

string

false

String hexadecimal que identifica o projeto a ser usado. Esta opção substitui as configurações no arquivo de configuração ou variável de ambiente.

--snapshotId

string

true

Identificador único do snapshot.

Nome
Tipo
Obrigatório
Descrição

-P, --profile

string

false

Nome do perfil a ser usado no arquivo de configuração. Para saber mais sobre perfis para o Atlas CLI, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

Se o comando for bem-sucedido, a CLI retornará uma saída semelhante à amostra a seguir. Os valores entre colchetes representam seus valores.

Export job '<Id>' created in a bucket with ID '<ExportBucketId>'.
# The following command exports one backup snapshot of the ExampleCluster cluster to an existing AWS S3 bucket:
atlas backup export jobs create --clusterName ExampleCluster --bucketId 62c569f85b7a381c093cc539 --snapshotId 62c808ceeb4e021d850dfe1b --customData name=test,info=test

Voltar

tarefa