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

cluster do Atlas sampleData describe

Nesta página

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

Retorne os detalhes da tarefa de carregamento de dados de amostra especificado.

Para usar esse comando, você deve autenticar com uma conta de usuário ou uma chave de API com o role de Somente Leitura do projeto.

Sintaxe do comando
atlas clusters sampleData describe <id> [options]
Nome
Tipo
Obrigatório
Descrição

id

string

true

Identificador único do trabalho de dados de amostra.

Nome
Tipo
Obrigatório
Descrição

-h, --help

false

ajuda para descrever

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

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.

ID CLUSTER NAME STATE
<Id> <ClusterName> <State>
# Return the JSON-formatted details for the sample data load job:
atlas clusters sampleData describe 5e98249d937cfc52efdc2a9f --output json

Voltar

Dados de amostra