OBTER /api/atlas/v1.0/groups/{groupId}/clusters
Contas de serviço DigestAuth

Retorna os detalhes de todos os clusters do projeto específico ao qual você tem acesso. Os clusters contêm um grupo de hosts que mantêm o mesmo conjunto de dados. A resposta não inclui clusters multinuvem . Para retornar clusters de multinuvem , use Obter todos os clusters avançados. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de "somente leitura" do projeto.

Esse ponto de extremidade também pode ser usado em clusters Flex que foram criados usando o endpoint Create Cluster ou em antigos clusters M2/M5 que foram migrados para clusters Flex até janeiro de 2026. Em vez disso, use o ponto de extremidade List Flex Clusters para clusters flexíveis.

Listar clusters flexíveis

parâmetros de caminho

  • groupId string Obrigatório

    Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair 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.

    O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

parâmetros de query

  • envelope booleano

    Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON 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 consulta. 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.

    O valor padrão é false.

  • incluir contagem booleano

    Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.

    O valor padrão é true.

  • itemsPerPage inteiro

    Número de itens que a resposta retorna por página.

    O valor mínimo é 1, o valor máximo é 500. O valor padrão é 100.

  • pageNum inteiro

    Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.

    O valor mínimo é 1. O valor padrão é 1.

  • pretty booleano

    Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

    O valor padrão é false.

    Prettyprint
  • includeDeletedWithRetainedBackups booleano

    Sinalizador que indica se clusters com backups retidos devem ser retornados.

    O valor padrão é false.

Respostas

  • 200 aplicação/json

    OK

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • links array[objeto]

      Lista de um ou mais localizadores uniformes de recursos (URLs) que ponto para sub-recursos de API, recursos de API relacionados ou ambos. A RFC 5988 descreve esses relacionamentos.

      Especificação de links da web (RFC...
      Ocultar atributos dos links Mostrar atributos dos links objeto
      • href string

        Localizador de recursos uniforme (URL) que aponta outro recurso de API para o qual essa resposta tem algum relacionamento. Essa URL geralmente começa com https://cloud.mongodb.com/api/atlas.

      • rel string

        Localizador de recursos uniforme (URL) que define a relacionamento semântica entre este recurso e outro recurso de API. Essa URL geralmente começa com https://cloud.mongodb.com/api/atlas.

    • Resultados array[objeto] Obrigatório

      Lista de documentos retornados que o MongoDB Cloud fornece ao concluir esta solicitação.

      Grupo de configurações que configuram um cluster MongoDB .

      Ocultar atributos de resultados Mostrar atributos de resultados objeto
      • acceptDataRisksAndForceReplicaSetReconfig string(data-hora)

        Se a reconfiguração for necessária para recuperar um primário devido a uma interrupção regional , envie esse campo junto com a reconfiguração da topologia para solicitar uma nova topologia resistente a interrupção regionais . Reconfigurações forçadas durante uma interrupção da maioria dos nós elegíveis acarretam um risco de perda de dados se as gravações replicadas (mesmo as gravações confirmadas pela maioria) não tiverem sido replicadas para o novo nó primário. Os docs do MongoDB Atlas contêm mais informações. Para prosseguir com uma operação que acarrete esse risco, defina acceptDataRisksAndForceReplicaSetReconfig para a data atual. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

        Reconfigurando um conjunto de réplicas du...
      • Configuração avançada objeto

        Grupo de configurações que define um subconjunto dos detalhes avançados de configuração.

        Ocultar atributos advancedConfiguration Mostrar atributos advancedConfiguration objeto
        • customOpensslCipherConfigTls12 array[string]

          A lista personalizada de conjuntos de cifras OpenSSL para TLS 1.2. Este campo só é válido quando tlsCipherConfigMode está definido como CUSTOM.

          Os valores são TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 ou TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256.

        • customOpensslCipherConfigTls13 array[string]

          A lista personalizada de conjuntos de cifras OpenSSL para TLS 1.3. Este campo só é válido quando tlsCipherConfigMode está definido como CUSTOM.

          Não mais do que 4 elementos. Os valores são TLS_AES_256_GCM_SHA384, TLS_CHACHA20_POLY1305_SHA256, TLS_AES_128_GCM_SHA256 ou TLS_AES_128_CCM_SHA256.

        • minimumEnabledTlsProtocol string

          Versão TLS (Transport Layer Security) mínima que o cluster aceita para conexões de entrada. Para clusters que usam TLS 1.0 ou 1.1, recomendamos definir o TLS 1.2 como a versão mínima do protocolo TLS.

          Os valores são TLS1_0, TLS1_1, TLS1_2 ou TLS1_3.

          Esta opção corresponde à...
        • tlsCipherConfigMode string

          O modo de configuração do conjunto de cifras TLS. O modo padrão usa os conjuntos de cifras padrão. O modo personalizado permite que você especifique conjuntos de cifras personalizados para TLS 1.2 e TLS 1.3.

          Os valores são CUSTOM ou DEFAULT.

      • autoScaling objeto

        Faixa de tamanhos de instâncias para os quais seu cluster pode ser dimensionado.

        Escalonamento automático de cluster
        Ocultar atributos de autoScaling Mostrar atributos de autoScaling objeto
        • computar objeto

          Coleção de configurações que configura como um cluster pode escalar sua camada do cluster e se o cluster pode ser reduzido. O auto-scaling da camada do cluster não está disponível para clusters que usam classes de armazenamento de baixa CPU ou NVME.

          Ocultar atributos de computação Mostrar atributos de computação objeto
          • habilitado booleano

            Sinalizador que indica se o auto-scaling reativo do tamanho da instância está habilitado.

            • Defina como true para habilitar o dimensionamento automático reativo do tamanho da instância. Se habilitado, você deve especificar um valor para providerSettings.autoScaling.compute.maxInstanceSize.
            • Defina como false para desabilitar o auto-scaling reativo do tamanho da instância.

            O valor padrão é false.

          • ScaleDownEnabled booleano

            Sinalizador que indica se a camada do cluster pode ser reduzida por meio do dimensionamento automático reativo. Isso é necessário se autoScaling.compute.enabled for true. Se você habilitar esta opção, especifique um valor para providerSettings.autoScaling.compute.minInstanceSize.

            O valor padrão é false.

        • diskGBEnabled booleano

          Sinalizador que indica se alguém habilitou o auto-scaling de disco para este cluster.

          O valor padrão é false.

      • backupEnabled booleano

        Sinalizador que indica se o cluster pode executar backups. Se definido como true, o cluster poderá executar backups. Você deve configurar este valor para true para clusters NVMe. O backup usa backups em nuvem para clusters dedicados e backups de cluster compartilhado para clusters de locatário. Se definido como false, o cluster não usará backups do MongoDB Cloud.

      • Bi Connector objeto

        Configurações necessárias para configurar o MongoDB Connector for Business Intelligence para esse cluster.

        MongoDB Connector for Business...
        Ocultar atributos do biConnector Mostrar atributos do biConnector objeto
        • habilitado booleano

          Sinalizador que indica se o MongoDB Connector for Business Intelligence está habilitado no cluster especificado.

        • readPreference string

          Nó da fonte de dados designado para o MongoDB Connector for Business Intelligence no MongoDB Cloud. O MongoDB Connector for Business Intelligence no MongoDB Cloud lê dados do nó primário, secundário ou de análise com base em suas preferências de leitura. O padrão é ANALYTICS nó ou SECONDARY se não houver ANALYTICS nós.

          Os valores são PRIMARY, SECONDARY ou ANALYTICS.

          Preferências de leitura para o BI Connector
      • clusterType string

        Configuração de nós que compõem o cluster.

        Os valores são REPLICASET, SHARDED ou GEOSHARDED.

      • configServerManagementMode string

        Modo de gerenciamento do servidor de configuração para criar ou atualizar um cluster fragmentado. Quando configurado como ATLAS_MANAGED, o Atlas pode alternar automaticamente o tipo de servidor de configuração do cluster para desempenho e economia ideais. Quando configurado como FIXED_TO_DEDICATED, o cluster sempre usará um servidor de configuração dedicado.

        Os valores são ATLAS_MANAGED ou FIXED_TO_DEDICATED. O valor padrão é ATLAS_MANAGED.

        Configuração de cluster fragmentado MongoDB ...
      • configServerType string

        Descreve o tipo de servidor de configuração de um cluster fragmentado.

        Os valores são DEDICATED ou EMBEDDED.

        Configuração de cluster fragmentado MongoDB ...
      • Connection strings objeto

        Coleção de localizadores uniformes de recursos que apontam para o banco de dados MongoDB.

        Formato de URI da string de conexão.
        Ocultar atributos connectionStrings Mostrar atributos connectionStrings objeto
        • awsPrivateLink objeto

          Connection strings privadas com reconhecimento de endpoints que usam clusters hospedados na AWS com o Amazon Web Services (AWS) PrivateLink. Cada chave identifica um ponto de extremidade da interface do Amazon Web Services (AWS). Cada valor identifica a string de conexão mongodb:// relacionada que você usa para se conectar ao MongoDB Cloud por meio do ponto de extremidade da interface que a chave nomeia.

          Conexão de peering de rede
          Ocultar atributo awsPrivateLink Mostrar atributo awsPrivateLink objeto
          • * string Propriedades adicionais

            Connection strings privadas com reconhecimento de endpoints que usam clusters hospedados na AWS com o Amazon Web Services (AWS) PrivateLink. Cada chave identifica um ponto de extremidade da interface do Amazon Web Services (AWS). Cada valor identifica a string de conexão mongodb:// relacionada que você usa para se conectar ao MongoDB Cloud por meio do ponto de extremidade da interface que a chave nomeia.

            Conexão de peering de rede
        • awsPrivateLinkSrv objeto

          Connection strings privadas com reconhecimento de endpoints que usam clusters hospedados na AWS com o Amazon Web Services (AWS) PrivateLink. Cada chave identifica um ponto de extremidade da interface do Amazon Web Services (AWS). Cada valor identifica a string de conexão mongodb:// relacionada que você usa para se conectar ao Atlas por meio do ponto de extremidade da interface que a chave nomeia. Se o cluster usar uma string de conexão otimizada, awsPrivateLinkSrv conterá a string de conexão otimizada. Se o cluster tiver a string de conexão não otimizada ( legado ), awsPrivateLinkSrv conterá a string de conexão não otimizada, mesmo que uma string de conexão otimizada também esteja presente.

          Conexão de peering de rede
          Ocultar atributo awsPrivateLinkSrv Mostrar atributo awsPrivateLinkSrv objeto
          • * string Propriedades adicionais

            Connection strings privadas com reconhecimento de endpoints que usam clusters hospedados na AWS com o Amazon Web Services (AWS) PrivateLink. Cada chave identifica um ponto de extremidade da interface do Amazon Web Services (AWS). Cada valor identifica a string de conexão mongodb:// relacionada que você usa para se conectar ao Atlas por meio do ponto de extremidade da interface que a chave nomeia. Se o cluster usar uma string de conexão otimizada, awsPrivateLinkSrv conterá a string de conexão otimizada. Se o cluster tiver a string de conexão não otimizada ( legado ), awsPrivateLinkSrv conterá a string de conexão não otimizada, mesmo que uma string de conexão otimizada também esteja presente.

            Conexão de peering de rede
        • privado string

          Strings de conexão de peering de rede para cada ponto de extremidade da Virtual Private Cloud (VPC) que você configurou para se conectar a esse cluster. Esta string de conexão utiliza o protocolo mongodb+srv://. O recurso retorna esse parâmetro quando alguém cria uma conexão de peering de rede com esse cluster. Este protocolo instrui o aplicativo a procurar a lista de sementes do host no Sistema de Nomes de Domínio (DNS). Esta lista sincroniza com os nós em um cluster. Se a string de conexão usar esse formato de Identificador de Recursos Uniforme (URI), você não precisará anexar a lista de sementes nem alterar o URI se os nós mudarem. Use este formato de URI se o seu driver suportar. Caso contrário, use connectionStrings.private. Para clusters da Amazon Web Services (AWS), esse recurso retorna esse parâmetro somente se você habilitar o DNS personalizado.

          Conexão de peering de rede
        • privateEndpoint array[objeto]

          Lista de connection strings com reconhecimento de endpoints privados que você pode usar para se conectar a esse cluster por meio de um endpoint privado. Este parâmetro retorna somente se você distribuiu um endpoint privado em todas as regiões para as quais distribuiu os nós deste cluster.

          string de conexão privada com reconhecimento de endpoint que você pode usar para se conectar a esse cluster por meio de um endpoint privado.

          Ocultar atributos privateEndpoint Mostrar atributos privateEndpoint objeto
          Pontos de extremidade privados para Dedicados...
          • ConnectionString string

            string de conexão privada com reconhecimento de endpoint que usa o protocolo mongodb:// para se conectar ao MongoDB Cloud por meio de um endpoint privado.

          • pontos de extremidade array[objeto]

            Lista que contém os pontos de extremidade privados por meio da qual você se conecta ao MongoDB nuvem quando usa connectionStrings.privateEndpoint[n].connectionString ou connectionStrings.privateEndpoint[n].srvConnectionString.

            Detalhes de um endpoint privado implantado para este cluster.

            Ocultar atributos de endpoints Mostrar atributos de endpoints objeto
            • endpointId string

              String única que o provedor de nuvem usa para identificar o endpoint privado.

            • providerName string

              Provedor de nuvem no qual a MongoDB Cloud implementa o endpoint privado.

              Os valores são AWS, AZURE ou GCP.

            • região string

              Região onde o endpoint privado está implantado.

          • srvConnectionString string

            string de conexão privada com reconhecimento de endpoint que usa o protocolo mongodb+srv:// para se conectar ao MongoDB Cloud por meio de um endpoint privado. O protocolo mongodb+srv informa ao driver para procurar a lista de sementes de hosts no Sistema de Nome de Domínio (DNS). Esta lista sincroniza com os nós em um cluster. Se a string de conexão usar este formato de Identificador de Recursos Unificado (URI), você não precisará anexar a lista de sementes nem alterar o Identificador de Recursos Unificado (URI) se os nós forem alterados. Use este formato de identificador de recurso uniforme (URI) se seu aplicativo suportar. Caso contrário, use connectionStrings.privateEndpoint[n].connectionString.

          • srvShardOptimizedConnectionString string

            string de conexão privada com reconhecimento de ponto de extremidade privado otimizada para clusters fragmentados que usa o protocolo mongodb+srv:// para se conectar ao MongoDB nuvem por meio de um ponto de extremidade privado. Se a string de conexão usar este formato de Identificador de Recursos Unificado (URI), você não precisará alterar o Identificador de Recursos Unificado (URI) se os nós forem alterados. Use este formato de Identificador de Recurso Uniform (URI) se seu aplicativo e o cluster do Atlas permitir. Caso contrário, use e consulte a documentação de connectionStrings.privateEndpoint[n].srvConnectionString.

          • type string

            Tipo de processo do MongoDB ao qual seu aplicação se conecta. Use MONGOD para conjuntos de réplicas e MONGOS para clusters fragmentados.

            Os valores são MONGOD ou MONGOS.

        • privateSrv string

          Connection strings de emparelhamento de rede para cada ponto de conexão da Virtual Private Cloud (VPC) que você configurou para se conectar a esse cluster. Esta string de conexão utiliza o mongodb+srv:// protocolo. O recurso retorna esse parâmetro quando alguém cria uma conexão de peering de rede com esse cluster. Este protocolo instrui o aplicação a procurar a lista de sementes do host no Sistema de Nomes de Domínio (DNS). Esta lista sincroniza com os nós em um cluster. Se a string de conexão usar este formato de Identificador de Recursos Unificado (URI), você não precisará anexar a lista de sementes nem alterar o Identificador de Recursos Unificado (URI) se os nós forem alterados. Use este formato de Identificador de recurso uniforme (URI) se o driver suportar. Caso contrário,connectionStrings.private use. Para clusters da Amazon Web Services (AWS), esse parâmetro retornará somente se você habilitar o DNS personalizado.

          Conexão de peering de rede
        • padrão string

          string de conexão pública que você pode usar para se conectar a esse cluster. Esta string de conexão utiliza o protocolo mongodb://.

          Formato de URI da connection string
        • standardSrv string

          string de conexão pública que você pode usar para se conectar a esse cluster. Esta string de conexão utiliza o protocolo mongodb+srv://.

          Formato de URI da connection string
      • data de criação string(data-hora)

        Data e hora em que o MongoDB Cloud criou esta instância sem servidor. O MongoDB Cloud representa esse registro de data/hora no formato ISO 8601 em UTC.

      • deleteAfterCreationHours integer(int32)

        Número de horas após a criação do cluster em que este cluster será excluído automaticamente.

        Este campo é usado para derivar deleteAfterDate em relação a createDate.

        Quando definido como nulo ou zero na criação do cluster, o cluster não será excluído automaticamente.

        Quando definido para um valor positivo na criação do cluster, o cluster será automaticamente excluído após o número de horas especificado.

        Ao atualizar este campo em um cluster existente (não excluído) e este estiver definido como nulo, os valores existentes serão preservados para este & deleteAfterDate.

        Ao atualizar este campo em um cluster existente (não excluído) e este estiver configurado para zero, então deleteAfterDate será redefinido para nulo (desabilitar exclusão automática), independentemente das configurações anteriores.

        Ao atualizar este campo em um cluster existente (não excluído), e este estiver definido para um valor positivo, então createDate + deleteAfterCreationHours deve ser posterior a agora, caso contrário a atualização do campo é ignorada e os valores existentes são preservados para este & deleteAfterDate.

      • deleteAfterDate string(data-hora)

        A data em que este cluster será automaticamente excluído.

        Esse parâmetro expressa seu valor no formato de carimbo de data/hora ISO 8601 em UTC e é derivado com base em createDate + deleteAfterCreationHours.

      • diskSizeGB número (duplo)

        Capacidade de armazenamento dos volumes de dados da instância expressa em gigabytes. Aumente esse número para aumentar a capacidade.

        Este valor não é configurável em clusters M0/M2/M5 .

        O MongoDB nuvem exige este parâmetro se você definir o replicationSpecs.

        Se você especificar um tamanho de disco abaixo do mínimo (10 GB), esse parâmetro assumirá como padrão o valor mínimo do tamanho do disco.

        Os cálculos da cobrança de armazenamento dependem de você escolher o valor padrão ou um valor personalizado.

        O valor máximo para armazenamento em disco não pode exceder 50 vezes o máximo de RAM para o cluster selecionado. Se você precisar de mais espaço de armazenamento, considere fazer upgrade do seu cluster para um nível superior.

        O valor mínimo é 10, o valor máximo é 4096.

      • diskWarmingMode string

        Seleção de modo de aquecimento do disco.

        Os valores são FULLY_WARMED ou VISIBLE_EARLIER. O valor padrão é FULLY_WARMED.

        Reduza o aquecimento do disco secundário...
      • encryptionAtRestProvider string

        Fornecedor de serviços em nuvem que gerencia suas chaves de cliente para garantir uma camada adicional de criptografia em descanso para o cluster. Para habilitar o gerenciamento de chaves de cliente para criptografia em descanso, a configuração do cluster replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize deve ser M10 ou superior e "backupEnabled" : false ou ser totalmente omitida.

        Os valores são NONE, AWS, AZURE ou GCP.

        criptografia em descanso usando Custo...
      • Versão de compatibilidade de recursos string

        Versão de compatibilidade de recursos do cluster.

      • featureCompatibilityVersionExpirationDate string(data-hora)

        Data de expiração da versão de compatibilidade do recurso. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

      • globalClusterSelfManagedSharding booleano

        Defina esse campo para configurar o modo de Gerenciamento de Fragmentação ao criar um novo cluster global.

        Quando definido como falso, o modo de gerenciamento é definido como fragmentação autogerenciada do Atlas. Esse modo gerencia totalmente a fragmentação do seu cluster global e foi criado para fornecer uma experiência de implantação perfeita.

        Quando definido como verdadeiro, o modo de gerenciamento é definido como Fragmentação autogerenciada. Esse modo deixa o gerenciamento de fragmentos em suas mãos e foi criado para fornecer uma experiência de implantação avançada e flexível.

        Essa configuração não pode ser alterada depois que o cluster for implantado.

        Criando um cluster global
      • groupId string

        String exclusiva de 24 caracteres hexadecimais que identifica o projeto.

        O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

      • id string

        String exclusiva de 24 caracteres hexadecimais que identifica o cluster.

        O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

      • rótulos array[objeto] Obsoleto(a)

        Coleção de pares chave-valor entre 1 a 255 caracteres de comprimento que marcam e categorizam o cluster. O console do MongoDB Cloud não exibe seus rótulos.

        As etiquetas de cluster estão obsoletas e serão removidas em uma versão futura. Em vez disso, é altamente recomendável usar tags de recursos.

        Rótulos legíveis por humanos aplicados a este componente MongoDB Cloud.

        Resource Tags
        Ocultar atributos de rótulos Mostrar atributos de rótulos objeto
        • chave string

          Chave aplicada para marcar e categorizar este componente.

          O comprimento mínimo é 1, o comprimento máximo é 255.

        • valor string

          Valor definido para a chave aplicada para marcar e categorizar este componente.

          O comprimento mínimo é 1, o comprimento máximo é 255.

      • links array[objeto]

        Lista de um ou mais localizadores uniformes de recursos (URLs) que ponto para sub-recursos de API, recursos de API relacionados ou ambos. A RFC 5988 descreve esses relacionamentos.

        Especificação de links da web (RFC...
        Ocultar atributos dos links Mostrar atributos dos links objeto
        • href string

          Localizador de recursos uniforme (URL) que aponta outro recurso de API para o qual essa resposta tem algum relacionamento. Essa URL geralmente começa com https://cloud.mongodb.com/api/atlas.

        • rel string

          Localizador de recursos uniforme (URL) que define a relacionamento semântica entre este recurso e outro recurso de API. Essa URL geralmente começa com https://cloud.mongodb.com/api/atlas.

      • mongoDBEmployeeAccessGrant objeto

        Funcionário do MongoDB recebeu nível de acesso e expiração para um cluster.

        Ocultar atributos mongoDBEmployeeAccessGrant Mostrar atributos do mongoDBEmployeeAccessGrant objeto
        • expirationTime string(data-hora) Obrigatório

          Data de expiração da concessão de acesso do funcionário. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

        • grantType string Obrigatório

          Nível de acesso a ser concedido aos funcionários do MongoDB.

          Os valores são CLUSTER_DATABASE_LOGS, CLUSTER_INFRASTRUCTURE ou CLUSTER_INFRASTRUCTURE_AND_APP_SERVICES_SYNC_DATA.

        • links array[objeto]

          Lista de um ou mais localizadores uniformes de recursos (URLs) que ponto para sub-recursos de API, recursos de API relacionados ou ambos. A RFC 5988 descreve esses relacionamentos.

          Especificação de links da web (RFC...
          Ocultar atributos dos links Mostrar atributos dos links objeto
          • href string

            Localizador de recursos uniforme (URL) que aponta outro recurso de API para o qual essa resposta tem algum relacionamento. Essa URL geralmente começa com https://cloud.mongodb.com/api/atlas.

          • rel string

            Localizador de recursos uniforme (URL) que define a relacionamento semântica entre este recurso e outro recurso de API. Essa URL geralmente começa com https://cloud.mongodb.com/api/atlas.

      • mongoDBMajorVersion string

        Versão principal do MongoDB do cluster.

        Na criação: escolha entre as versões disponíveis do MongoDB ou deixe sem especificar o padrão atual recomendado na plataforma MongoDB Cloud. A versão recomendada é uma versão recente de suporte de longo prazo. Não é garantido que o padrão seja a versão lançada mais recentemente durante todo o ciclo de lançamento. Para versões disponíveis em um projeto específico, consulte a documentação vinculada ou use o ponto de extremidade da API para o ponto de extremidade de versões LTS do projeto.

        Na atualização: aumente a versão somente na versão principal 1 por vez. Se o cluster estiver fixado em uma versão de compatibilidade de recursos do MongoDB, exatamente uma versão principal abaixo da versão atual do MongoDB, a versão do MongoDB poderá ser rebaixada para a versão principal anterior.

        Versões do MongoDB disponíveis em...
      • Versão do MongoDB string

        Versão do MongoDB que o cluster executa.

        O formato deve corresponder ao seguinte padrão: ([\d]+\.[\d]+\.[\d]+).

      • mongoURI string

        string de conexão base que você pode usar para se conectar ao cluster. O MongoDB Cloud exibe a string somente após o início do cluster, não enquanto constrói o cluster.

        Formato de URI da string de conexão.
      • mongoURIUpdated string(data-hora)

        Data e hora em que alguém atualizou a string de conexão pela última vez. O MongoDB Cloud representa esse registro de data/hora no formato ISO 8601 em UTC.

      • mongoURIWithOptions string

        Connection string que você pode utilizar para conectar ao cluster incluindo os parâmetros de consulta replicaSet, ssl e authSource com valores apropriados para o cluster. Talvez seja necessário adicionar usuários do banco de dados MongoDB . A resposta retorna esse parâmetro quando o cluster pode receber solicitações, não enquanto ele cria o cluster.

        Formato de URI da string de conexão.
      • name string

        Etiqueta legível por humanos que identifica o cluster.

        O formato deve corresponder ao seguinte padrão: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.

      • numShards integer(int32)

        Número de fragmentos até 50 a serem implantados em um cluster fragmentado. O recurso retorna 1 para indicar um conjunto de réplica e valores de 2 e superior para indicar um cluster fragmentado. O valor retornado é igual ao número de fragmentos do cluster.

        O valor mínimo é 1, o valor máximo é 50. O valor padrão é 1.

        Fragmentação
      • pausado booleano

        Sinalizador que indica se o cluster está pausado.

      • pitEnabled booleano

        Sinalizador que indica se o cluster usa backups contínuos na nuvem.

        Backups contínuos da nuvem
      • providerBackupEnabled booleano

        Sinalizador que indica se o cluster M10 ou superior pode executar backups em nuvem. Se definido como true, o cluster poderá executar backups. Se isso e backupEnabled estiverem definidos como false, o cluster não usará backups em nuvem do MongoDB.

      • providerSettings objeto

        Um dos seguintes:
        objeto AWS objeto AZURE objeto GCP objeto LOCATÁRIO objeto Flex
      • replicaSetScalingStrategy string

        Defina esse campo para configurar o modo de dimensionamento do conjunto de réplicas para seu cluster.

        Por padrão, o Atlas dimensiona abaixo de WORKLOAD_TYPE. Este modo permite ao Atlas dimensionar seus nós de análise em paralelo com seus nós operacionais.

        Quando configurado como SEQUENTIAL, o Atlas dimensiona todos os nós sequencialmente. Esse modo é destinado a cargas de trabalho de estado estável e aplicativos que executam leituras secundárias sensíveis à latência.

        Quando configurado como NODE_TYPE, o Atlas dimensiona seus nós elegíveis em paralelo com seus nós de análise. Esse modo destina-se a cargas de trabalho grandes e dinâmicas que exigem dimensionamento frequente e atempado da camada do cluster. Essa é a estratégia de dimensionamento mais rápida, mas pode impacto a latência das cargas de trabalho ao realizar leituras secundárias extensivas.

        Os valores são SEQUENTIAL, WORKLOAD_TYPE ou NODE_TYPE. O valor padrão é WORKLOAD_TYPE.

        Modifique o dimensionamento do conjunto de réplicas...
      • Fator de replicação integer(int32) Obsoleto(a)

        Número de nós que pertencem ao conjunto de réplicas. Cada nó mantém uma cópia dos seus bancos de dados, proporcionando uma alta disponibilidade e uma redundância de dados. Em vez disso, use replicationSpecs.

        Os valores são 3, 5 ou 7. O valor padrão é 3.

      • replicationSpec objeto

        Local físico onde o MongoDB Cloud provisiona nós de cluster.

        Ocultar atributo replicationSpec Mostrar atributo replicationSpec objeto
        • * objeto Propriedades adicionais

          Local físico onde o MongoDB Cloud provisiona nós de cluster.

          Ocultar atributos * Mostrar atributos * objeto
          • Nós de análise integer(int32)

            Número de nós de análise na região. Os nós de análise lidam com dados analíticos, como relatório queries do MongoDB Connector for Business Intelligence na MongoDB nuvem. Os nós de análise são somente leitura e nunca podem se tornar os primário. Em vez disso, use replicationSpecs[n].{region}.analyticsNodes.

          • elegableNodes integer(int32)

            Número de nós elegíveis para implantar na região especificada. Os nós elegíveis podem se tornar os primários e facilitar as leituras locais. Em vez disso, use replicationSpecs[n].{region}.electableNodes.

            Os valores são 0, 3, 5 ou 7.

          • Prioridade integer(int32)

            Número que indica a prioridade eleição da região. Para identificar a região preferencial do cluster, defina este parâmetro 7 como. O nó primário é executado na Região preferencial. Para identificar uma região somente leitura, defina este parâmetro 0 como.

            O valor mínimo é 0, o valor máximo é 7.

          • ReadOnlyNodes integer(int32)

            Número de nós somente leitura na região. Os nós somente leitura nunca podem se tornar o membro principal, mas podem facilitar leituras locais. Em vez disso, use replicationSpecs[n].{region}.readOnlyNodes.

      • replicationSpecs array[objeto]

        Lista de configurações que definem suas regiões de cluster.

        • Para clusters globais, cada objeto na array representa uma zona onde o MongoDB Cloud implanta seus nós de clusters.
        • Para conjuntos de réplicas e clusters fragmentados não globais, o objeto único representa onde o MongoDB Cloud implanta seus nós de clusters.
        Ocultar atributos replicationSpecs Mostrar atributos replicationSpecs objeto
        • id string

          String única de 24dígitos hexadecimais que identifica o objeto de replicação de uma zona em um cluster global.

          • Se você incluir zonas existentes na solicitação, deverá especificar este parâmetro.

          • Se você adicionar uma nova zona a um cluster global existente, poderá especificar este parâmetro. A solicitação exclui quaisquer zonas existentes em um Cluster Global que você exclua da solicitação.

          O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

        • numShards integer(int32)

          Inteiro positivo que especifica o número de fragmentos a serem implantados em cada zona especificada Se você definir esse valor como 1 e clusterType for SHARDED, o MongoDB nuvem implantará um cluster de fragmento único. Não crie um cluster fragmentado com um único fragmento para ambientes de produção. Os clusters de fragmentos únicos não fornecem os mesmos benefícios que as configurações de vários fragmentos.

          Se você estiver atualizando um conjunto de réplicas para um cluster fragmentado, não poderá aumentar o número de fragmentos na mesma solicitação de atualização. Você deve aguardar até que o cluster conclua a atualização para fragmentado e você tenha reconectado todos os clientes de aplicação ao roteador MongoDB antes de adicionar fragmentos adicionais. Caso contrário, seus dados podem se tornar inconsistentes quando o MongoDB Cloud começar a distribuir dados entre os fragmentos.

          O valor padrão é 1.

        • regionsConfig objeto

          Local físico onde o MongoDB Cloud provisiona nós de cluster.

          Ocultar atributo regiõesConfig Mostrar atributo regiõesConfig objeto
          • * objeto Propriedades adicionais

            Local físico onde o MongoDB Cloud provisiona nós de cluster.

            Ocultar atributos * Mostrar atributos * objeto
            • Nós de análise integer(int32)

              Número de nós de análise na região. Os nós de análise lidam com dados analíticos, como relatório queries do MongoDB Connector for Business Intelligence na MongoDB nuvem. Os nós de análise são somente leitura e nunca podem se tornar os primário. Em vez disso, use replicationSpecs[n].{region}.analyticsNodes.

            • elegableNodes integer(int32)

              Número de nós elegíveis para implantar na região especificada. Os nós elegíveis podem se tornar os primários e facilitar as leituras locais. Em vez disso, use replicationSpecs[n].{region}.electableNodes.

              Os valores são 0, 3, 5 ou 7.

            • Prioridade integer(int32)

              Número que indica a prioridade eleição da região. Para identificar a região preferencial do cluster, defina este parâmetro 7 como. O nó primário é executado na Região preferencial. Para identificar uma região somente leitura, defina este parâmetro 0 como.

              O valor mínimo é 0, o valor máximo é 7.

            • ReadOnlyNodes integer(int32)

              Número de nós somente leitura na região. Os nós somente leitura nunca podem se tornar o membro principal, mas podem facilitar leituras locais. Em vez disso, use replicationSpecs[n].{region}.readOnlyNodes.

        • zoneName string

          Rótulo legível por humanos que identifica a zona em um cluster global. Forneça este valor somente se clusterType for GEOSHARDED.

      • rootCertType string

        Autoridade de certificado raiz que o cluster MongoDB Atlas utiliza. O MongoDB Cloud é compatível com oInternet Segurança Research Group.

        O valor é ISRGROOTX1. O valor padrão é ISRGROOTX1.

      • srvAddress string

        String de conexão que você pode usar para se conectar ao cluster. O modificador +srv força a conexão a usar o TLS (Transport Layer Security). O parâmetro mongoURI lista opções adicionais.

        Formato de URI da string de conexão.
      • stateName string

        Etiqueta legível para humanos que indica qualquer atividade atual que esteja sendo realizada neste cluster pelo plano de controle Atlas . Com exceção dos estados CREATING e DELETING, os clusters devem estar sempre disponíveis e ter um nó primário, mesmo quando em estados que indicam atividade contínua.

        • IDLE: o Atlas não está fazendo alterações neste cluster e pode-se presumir que todas as alterações solicitadas por meio da UI ou da API foram aplicadas.
        • CREATING: um cluster que está sendo provisionado pela primeira vez retorna o estado CREATING até que esteja pronto para conexões. Certifique-se de que a Lista de Acesso IP e os Usuários do Banco de Dados estejam configurados antes de tentar se conectar.
        • UPDATING: Uma alteração solicitada por meio da UI, API, AutoScaling ou outra atividade programada está ocorrendo.
        • DELETING: o cluster está em processo de exclusão e será excluído em breve.
        • REPAIRING: Um ou mais nós no cluster estão sendo devolvidos ao serviço pelo plano de controle Atlas . Outros nós devem continuar fornecendo serviços normalmente.

        Os valores são IDLE, CREATING, UPDATING, DELETING ou REPAIRING.

      • tags array[objeto]

        Lista que contém pares de valor-chave entre 1 e 255 caracteres para marcar e categorizar o cluster.

        Par de valores-chave que marca e categoriza uma organização, projeto ou cluster do MongoDB Cloud. Por exemplo, environment : production.

        Resource Tags
        Hide tags attributes Mostrar atributos das tags objeto
        • chave string Obrigatório

          Constante que define o conjunto da tag. Por exemplo, environment na marcação environment : production .

          O comprimento mínimo é 1, o comprimento máximo é 255.

        • valor string Obrigatório

          Variável que pertence ao conjunto da tag. Por exemplo, production na marcação environment : production .

          O comprimento mínimo é 1, o comprimento máximo é 255.

      • terminationProtectionEnabled booleano

        Sinalizador que indica se a proteção de rescisão está habilitada no cluster. Se definido como true, o MongoDB Cloud não excluirá o cluster. Se definido como false, o MongoDB Cloud excluirá o cluster.

        O valor padrão é false.

      • versionReleaseSystem string

        Método pelo qual o cluster mantém as versões do MongoDB . Se o valor for CONTINUOUS, você não deverá especificar mongoDBMajorVersion.

        Os valores são LTS ou CONTINUOUS. O valor padrão é LTS.

    • contagem total integer(int32)

      Número total de documentos disponíveis. O MongoDB Cloud omite este valor se includeCount estiver definido como false. O número total é uma estimativa e pode não ser exato.

      O valor mínimo é 0.
  • 401 aplicação/json

    Não autorizado.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.
  • 403 aplicação/json

    Forbidden.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.
  • 404 aplicação/json

    Não encontrado.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.
  • 500 aplicação/json

    Erro interno do servidor.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.
GET /API/atlas/v1.0/groups/{groupId}/clusters 
curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/clusters' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Exemplos de resposta (200) 
{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "acceptDataRisksAndForceReplicaSetReconfig": "2026-05-04T09:42:00Z",
      "advancedConfiguration": {
        "customOpensslCipherConfigTls12": [
          "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
        ],
        "customOpensslCipherConfigTls13": [
          "TLS_AES_256_GCM_SHA384"
        ],
        "minimumEnabledTlsProtocol": "TLS1_0",
        "tlsCipherConfigMode": "CUSTOM"
      },
      "autoScaling": {
        "compute": {
          "enabled": false,
          "scaleDownEnabled": false
        },
        "diskGBEnabled": false
      },
      "backupEnabled": true,
      "biConnector": {
        "enabled": true,
        "readPreference": "PRIMARY"
      },
      "clusterType": "REPLICASET",
      "configServerManagementMode": "ATLAS_MANAGED",
      "configServerType": "DEDICATED",
      "connectionStrings": {
        "awsPrivateLink": {
          "additionalProperty1": "string",
          "additionalProperty2": "string"
        },
        "awsPrivateLinkSrv": {
          "additionalProperty1": "string",
          "additionalProperty2": "string"
        },
        "private": "string",
        "privateEndpoint": [
          {
            "connectionString": "string",
            "endpoints": [
              {
                "endpointId": "string",
                "providerName": "AWS",
                "region": "string"
              }
            ],
            "srvConnectionString": "string",
            "srvShardOptimizedConnectionString": "string",
            "type": "MONGOD"
          }
        ],
        "privateSrv": "string",
        "standard": "string",
        "standardSrv": "string"
      },
      "createDate": "2026-05-04T09:42:00Z",
      "deleteAfterCreationHours": 42,
      "deleteAfterDate": "2026-05-04T09:42:00Z",
      "diskSizeGB": 42.0,
      "diskWarmingMode": "FULLY_WARMED",
      "encryptionAtRestProvider": "NONE",
      "featureCompatibilityVersion": "string",
      "featureCompatibilityVersionExpirationDate": "2026-05-04T09:42:00Z",
      "globalClusterSelfManagedSharding": true,
      "groupId": "32b6e34b3d91647abb20e7b8",
      "id": "32b6e34b3d91647abb20e7b8",
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "links": [
        {
          "href": "https://cloud.mongodb.com/api/atlas",
          "rel": "self"
        }
      ],
      "mongoDBEmployeeAccessGrant": {
        "expirationTime": "2026-05-04T09:42:00Z",
        "grantType": "CLUSTER_DATABASE_LOGS",
        "links": [
          {
            "href": "https://cloud.mongodb.com/api/atlas",
            "rel": "self"
          }
        ]
      },
      "mongoDBMajorVersion": "5.0",
      "mongoDBVersion": "5.0.25",
      "mongoURI": "string",
      "mongoURIUpdated": "2026-05-04T09:42:00Z",
      "mongoURIWithOptions": "string",
      "name": "string",
      "numShards": 1,
      "paused": true,
      "pitEnabled": true,
      "providerBackupEnabled": true,
      "providerSettings": {
        "providerName": "AWS",
        "autoScaling": {
          "compute": {
            "maxInstanceSize": "M10",
            "minInstanceSize": "M10"
          }
        },
        "diskIOPS": 42,
        "encryptEBSVolume": true,
        "instanceSizeName": "M10",
        "regionName": "US_GOV_WEST_1",
        "volumeType": "STANDARD"
      },
      "replicaSetScalingStrategy": "WORKLOAD_TYPE",
      "replicationFactor": 3,
      "replicationSpec": {
        "additionalProperty1": {
          "analyticsNodes": 42,
          "electableNodes": 0,
          "priority": 42,
          "readOnlyNodes": 42
        },
        "additionalProperty2": {
          "analyticsNodes": 42,
          "electableNodes": 0,
          "priority": 42,
          "readOnlyNodes": 42
        }
      },
      "replicationSpecs": [
        {
          "id": "32b6e34b3d91647abb20e7b8",
          "numShards": 1,
          "regionsConfig": {
            "additionalProperty1": {
              "analyticsNodes": 42,
              "electableNodes": 0,
              "priority": 42,
              "readOnlyNodes": 42
            },
            "additionalProperty2": {
              "analyticsNodes": 42,
              "electableNodes": 0,
              "priority": 42,
              "readOnlyNodes": 42
            }
          },
          "zoneName": "string"
        }
      ],
      "rootCertType": "ISRGROOTX1",
      "srvAddress": "string",
      "stateName": "IDLE",
      "tags": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "terminationProtectionEnabled": false,
      "versionReleaseSystem": "LTS"
    }
  ],
  "totalCount": 42
}
Exemplos de resposta (401) 
{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}
Exemplos de resposta (403) 
{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
Exemplos de resposta (404) 
{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}
Exemplos de resposta (500) 
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}