atlas api clusters updateClusterAdvancedConfiguration

O suporte do Atlas CLI para executar comandos com a API de administração do Atlas está em visualização. O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para saber mais, consulte Recursos de visualização.

Visualização pública: forneça comentários em: atualiza os detalhes de configuração avançada para um cluster no projeto especificado.

Os clusters contêm um grupo de hosts que mantêm o mesmo conjunto de dados. Detalhes de configuração avançada incluem read/ preocupação de gravação, limites de índice e oplog e outras configurações do banco de dados . Para utilizar esse recurso, a chave de API solicitante deve ter a função de "Gerenciador de cluster do projeto". Este recurso não está disponível para clusters gratuitos M0, clusters de nível compartilhado M2 e M5, clusters flexíveis ou clusters sem servidor.

Este comando é gerado automaticamente e 1 corresponde:1 ao endpoint da API do Atlas https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/#tag/Clusters/ operation/updateClusterAdvancedConfiguration.

Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.

Sintaxe

Sintaxe do comando

atlas api clusters updateClusterAdvancedConfiguration [options]

Opções

Nome	Tipo	Obrigatório	Descrição
--clusterName	string	true	Etiqueta legível por humanos que identifica o cluster.
--envelope	envelope	false	Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON de 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 query. 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.
--file	string	false	caminho para seu arquivo de solicitação de API. Deixe vazio para usar a entrada padrão - você deve fornecer um ou outro, mas não ambos.
--groupId	string	true	Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint [/groups](#tag/Projects/operation/listProjects) para recuperar 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.
-h, --help		false	ajuda para updateClusterAdvancedConfiguration
--output	string	false	formato de API preferido, pode ser ["JSON", go-template] Este valor padrão é "JSON".
--output-file	string	false	no qual gravar a saída da API. Esse sinalizador é necessário quando a saída de um endpoint é binária (por exemplo: gzip) e o comando não é piped (por exemplo: comando atlas > out.zip)
--pretty		false	Sinalizador que indica se o corpo da resposta deve estar no <a URL =https://en.wikipede.org/wiki/Prettyprint" formato target="_blank" rel="noopener noreferrer">pretty-print</a>.
--version	string	false	Versão da API a ser usada ao chamar a chamada da API [opções: "2023-01-01", "2024-08-05"], os padrões para a versão mais recente ou os perfis api_version valor de configuração se definido Este valor padrão é "2024-08-05".

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.