Remova o Atlas Online Archive especificado do seu cluster.
Visualização pública: o subcomando da API atlas, gerado automaticamente a partir da API de administração do MongoDB Atlas, oferece cobertura completa da API de administração e está atualmente em visualização pública (forneça feedback em https://feedback.mongodb.com/fóruns/930808-atlas-cli). Os recursos da API de administração têm seu próprio ciclo de vida de versão, que você pode verificar por meio do link de documentação do endpoint da API fornecido.
Para usar esse comando, você deve se autenticar com uma conta de usuário ou uma chave de API com a função de "administrador de acesso a dados do projeto".
Sintaxe
atlas clusters onlineArchives delete <archiveId> [options]
argumentos
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
archiveId | string | true | Identificador único do Atlas Online Archive a ser excluído. |
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--clusterName | string | true | Nome do cluster. Para saber mais, consulte https://dochub.mongodb.org/core/create-cluster-api. |
--force | false | Sinalizador que indica se o prompt de confirmação deve ser ignorado antes de prosseguir com a ação solicitada. | |
-h, --help | false | ajuda para excluir | |
--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. |
Opções herdadas
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. |
Saída
Se o comando for bem-sucedido, a CLI retornará uma saída semelhante à amostra a seguir. Os valores entre colchetes representam seus valores.
Archive '<Name>' deleted
Exemplos
# Remove an online archive with the ID 5f189832e26ec075e10c32d3 for the cluster named myCluster: atlas clusters onlineArchives delete 5f189832e26ec075e10c32d3 --clusterName myCluster