Alterna o adiamento automático da janela de manutenção do 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.
Quando o adiamento automático está ativado, todos os períodos de manutenção são adiados por uma semana. Esse ponto de extremidade controla o mesmo recurso subjacente que o campo autoDeferOnceEnabled no ponto de extremidade PATCH /maintenanceWindow. A diferença é que esse ponto de extremidade alterna o valor atual (mira de habilitado para desabilitado ou vice-versa), enquanto o campo autoDeferOnceEnabled permite definir um valor específico. Para a maioria dos casos de uso, o ponto de extremidade PATCH com autoDeferOnceEnabled é recomendado porque permite definir um valor explícito em vez de alternar. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de proprietário do projeto.
Este comando é gerado automaticamente e corresponde 1:1 ao ponto de extremidade da API do Atlashttps://www.mongodb.com/pt-br/docs/api/doc/atlas-admin-api-v2/operation/operation-togglegroupmaintenancewindowautodefer.
Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.
Sintaxe
atlas api maintenanceWindows toggleMaintenanceAutoDefer [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 toggleMaintenanceAutoDefer | |
-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 a chamada da API [opções: "2023-01-01"], o padrão é a versão mais recente ou o valor de configuração dos perfis api_version, se definido Este valor é padronizado como "2023-01a01". |
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 toggleMaintenanceAutoDefer --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8