Modifique a regra de arquivamento do Atlas Online Archive especificado para um 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 update <archiveId> [options]
argumentos
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
archiveId | string | true | Identificador único do Atlas Online Archive a ser atualizado. |
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--archiveAfter | int | false | Número de dias após os quais arquivar dados do cluster. Mutuamente exclusivo com --file. |
--clusterName | string | true | Nome do cluster. Para saber mais, consulte https://dochub.mongodb.org/core/create-cluster-api. |
--expireAfterDays | int | false | Número de dias usados nos critérios de data para indicar documentos para exclusão. Mutuamente exclusivo com --file. |
--file | string | false | Caminho para um arquivo de configuração JSON opcional que define as configurações do arquivo on-line. Observação: os campos não suportados no arquivo JSON são ignorados. Para saber mais sobre arquivos de configuração de arquivamento online para Atlas CLI, consulte https://dochub.mongodb.org/core/atlas-cli-json-online-archive-config. Mutuamente exclusivo com --archiveAfter, --expireAfterDays. |
-h, --help | false | ajuda para atualização | |
-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. |
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.
Online archive '<Id>' updated.
Exemplos
# Update the archiving rule to archive after 5 days for the online archive with the ID 5f189832e26ec075e10c32d3 for the cluster named myCluster: atlas clusters onlineArchives update 5f189832e26ec075e10c32d3 --clusterName --archiveAfter 5 myCluster --output json