Adia a período de manutenção para o projeto especificado.
O subcomando atlas api é gerado automaticamente a partir da API de administração do MongoDB Atlas e oferece cobertura completa da API de administração. As funcionalidades 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 ponto de extremidade da API fornecido.
Atividades de manutenção urgentes, como patches de segurança, não podem aguardar o período escolhido. O MongoDB Cloud inicia essas atividades de manutenção quando necessário. Depois de agendar a manutenção para o cluster, você não poderá alterar o período de manutenção até que o trabalho de manutenção atual seja concluído. O procedimento de manutenção que o MongoDB Cloud executa requer pelo menos uma eleição de conjunto de réplicas durante o período de manutenção por conjunto de réplicas. A manutenção sempre começa o mais próximo possível da hora programada, mas atualizações de cluster em andamento ou problemas inesperados do sistema podem atrasar a hora de início.
Este comando é gerado automaticamente e corresponde 1:1 ao ponto de extremidade da API do Atlas https://www.mongodb.com/pt-br/docs/api/doc/atlas-admin-api-v2/operation/operation-defergroupmaintenancewindow.
Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.
Sintaxe
atlas api maintenanceWindows deferMaintenanceWindow [options]
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--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. |
--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 deferMaintenanceWindow | |
-o, --output | string | false | formato de API preferido, pode ser ["JSON", go-template] Este valor padrão é "JSON". |
--outputFile | 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) |
--version | string | false | Versão da API a ser usada ao chamar os pontos de extremidade da API do Atlas [opções: "2023-01-01"]. Se não for definido pelo usuário, o padrão será a versão mais recente ou o valor de configuração api_version do perfil, se definido. Esse valor padroniza para "2023-01-01". |
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. |
Exemplos
atlas api maintenanceWindows deferMaintenanceWindow --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8