Retornar um cluster de um projeto Obsoleto(a)

OBTER /api/atlas/v2/groups/{groupId}/clusters/{clusterName}
Contas de serviço DigestAuth

Retorna os detalhes de um cluster no projeto especificado. Os clusters contêm um grupo de hosts que mantêm o mesmo conjunto de dados. A resposta inclui clusters com fragmentos de tamanho assimétrico. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função somente leitura do projeto. Esse recurso não está disponível para clusters sem servidor.

Esse endpoint também pode ser usado em clusters Flex que foram criados usando o endpoint createCluster ou em antigos clusters M 2/M5 que foram migrados para clusters Flex até janeiro 2026 de. Em vez disso, use o endpoint getFlexCluster para clusters Flex . Versões obsoletas: v2-{2023-01-01}

getFlexCluster

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})$.

  • clusterName string Obrigatório

    Etiqueta legível para humanos que identifica este cluster.

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

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.

  • pretty booleano

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

    O valor padrão é false.

    Prettyprint

Respostas

  • 200 application/vnd.atlas.2023-02-01+json

    OK

    Ocultar atributos de resposta Mostrar atributos de resposta 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ções 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 documentos 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.

      Reconfiguração de um conjunto de réplicas durante uma interrupção regional
    • 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.

      • 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 ou TLS1_2.

        Esta opção corresponde à opção de arquivo de configuração 'netssldisabledProtocols' 'mongod'
      • 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.

    • 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 clusters NVMe. O backup usa backups em nuvem para clusters especializados e backups de cluster compartilhados para clusters inquilinos. Se configurado para false, o cluster não utiliza backups.

      O valor padrão é false.

    • Bi Connector objeto

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

      MongoDB Connector para Business Intelligence
      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 otimizar o desempenho e a economia.

      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.

      Servidores de configuração de cluster fragmentado do MongoDB
    • configServerType string

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

      Os valores são DEDICATED ou EMBEDDED.

      Servidores de configuração de cluster fragmentado do MongoDB
    • Connection strings objeto

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

      Formato de URI da connection string
      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

        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 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 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 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
        • 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 endpoints privados por meio da qual você se conecta ao MongoDB Cloud ao usar 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 aplicação suportar. Caso contrário, use connectionStrings.privateEndpoint[n].connectionString.

        • srvShardOptimizedConnectionString string

          string de conexão privada com reconhecimento de endpoint otimizada para clusters fragmentados que usa o protocolo mongodb+srv:// para se conectar ao MongoDB Cloud por meio de um endpoint 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 aplicação e o cluster do Atlas permitir. Caso contrário, use e consulte a documentação para 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 este cluster. Este parâmetro expressa seu valor no formato ISO 8601 em UTC.

    • 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 Cloud exige este parâmetro se você definir 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.

      Personalizar armazenamento
    • 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 impacto do 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 repouso para o cluster. Para habilitar o gerenciamento de chaves de cliente para criptografia em repouso, 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 repouso usando o gerenciamento de chaves de cliente
    • 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 vinculação à web ( RFC 5988)
      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 vinculação à web ( RFC 5988)
        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 no Atlas
    • Versão do MongoDB string

      Versão do MongoDB que o cluster executa.

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

    • name string

      Etiqueta legível para humanos que identifica o cluster avançado.

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

    • 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
    • replicaSetScalingStrategy string

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

      Por padrão, o Atlas é dimensionado em WORKLOAD_TYPE. Esse modo permite que o Atlas dimensione seus nós de análise em paralelo aos seus nós operacionais.

      Quando configurado como SEQUÊNCIA, o Atlas dimensiona todos os nós sequencialmente. Este 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 somente leitura e de análise. Este modo é destinado a cargas de trabalho grandes e dinâmicas que exigem dimensionamento de camada do cluster frequente e oportuno. Essa é a estratégia de dimensionamento mais rápida, mas pode afetar a latência das cargas de trabalho ao realizar leituras secundárias extensas.

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

      Modifique o modo de dimensionamento do conjunto de réplicas
    • replicationSpecs array[objeto]

      Lista de configurações que configuram suas regiões de cluster. Para clusters globais, cada objeto na array representa uma zona onde os nós dos clusters são distribuídos. Para clusters fragmentados não globais e conjuntos de réplicas, essa array tem um objeto que representa onde os nós dos clusters são distribuídos.

      Detalhes que explicam como o MongoDB Cloud replica dados no banco de dados MongoDB especificado.

      Ocultar atributos replicationSpecs Mostrar atributos replicationSpecs objeto
      • id string

        String exclusiva de 24dígitos hexadecimais que identifica o objeto de replicação para uma zona em um cluster de várias nuvens. Se você incluir zonas existentes na solicitação, deverá especificar este parâmetro. Se você adicionar uma nova zona a um cluster multinuvem existente, poderá especificar este parâmetro. A solicitação exclui quaisquer zonas existentes no Cluster Multinuvem que você exclui 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 implementados em cada zona especificada. Se você definir esse valor como 1 e clusterType for SHARDED, o MongoDB Cloud implantará um cluster fragmentado de shard ú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 mínimo é 1.

      • regionConfigs array[objeto]

        Especificações de hardware para nós definidos para uma determinada região. Cada objeto regionConfigs deve ser exclusivo por região e provedor de nuvem dentro do replicationSpec. Cada objeto regionConfigs descreve a prioridade da região nas eleições e o número e tipo de nós MongoDB que o MongoDB Cloud implementa na região. Cada objeto regionConfigs deve ter um objeto analyzeSpecs , objeto elegableSpecs ou objeto readOnlySpecs . Os clusters de locatários exigem apenas elegableSpecs. Os clusters dedicados podem especificar qualquer uma dessas especificações, mas devem ter pelo menos um objeto elegableSpecs dentro de um replicationSpec. Cada especificação de hardware deve usar o mesmo instanceSize.

        Exemplo:

        Se você definir "replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize" : "M30", defina "replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize" :"M30"if you have electable nodes and"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize" : "M30" se você tiver nós somente leitura.

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

        String exclusiva de 24dígitos hexadecimais que identifica uma zona em um cluster global.

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

      • zoneName string

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

    • rootCertType string

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

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

    • 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.
  • 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.
  • 409 aplicação/json

    Conflito.

    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/v2/groups/{groupId}/clusters/{clusterName} 
atlas api clusters getGroupCluster --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20231115001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.GetGroupClusterApiParams{}
	sdkResp, httpResp, err := client.ClustersApi.
		GetGroupClusterWithParams(ctx, params).
		Execute()
}

curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2023-11-15+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2023-11-15+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}?pretty=true"
Exemplos de resposta (200) 
{
  "acceptDataRisksAndForceReplicaSetReconfig": "2025-05-04T09:42:00Z",
  "advancedConfiguration": {
    "customOpensslCipherConfigTls12": [
      "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
    ],
    "minimumEnabledTlsProtocol": "TLS1_0",
    "tlsCipherConfigMode": "CUSTOM"
  },
  "backupEnabled": false,
  "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": "2025-05-04T09:42:00Z",
  "diskSizeGB": 42.0,
  "diskWarmingMode": "FULLY_WARMED",
  "encryptionAtRestProvider": "NONE",
  "featureCompatibilityVersion": "string",
  "featureCompatibilityVersionExpirationDate": "2025-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": "2025-05-04T09:42:00Z",
    "grantType": "CLUSTER_DATABASE_LOGS",
    "links": [
      {
        "href": "https://cloud.mongodb.com/api/atlas",
        "rel": "self"
      }
    ]
  },
  "mongoDBMajorVersion": "string",
  "mongoDBVersion": "string",
  "name": "string",
  "paused": true,
  "pitEnabled": true,
  "replicaSetScalingStrategy": "WORKLOAD_TYPE",
  "replicationSpecs": [
    {
      "id": "32b6e34b3d91647abb20e7b8",
      "numShards": 42,
      "regionConfigs": [
        {
          "": {
            "diskIOPS": 42,
            "ebsVolumeType": "STANDARD",
            "instanceSize": "M10",
            "nodeCount": 42
          },
          "priority": 42,
          "providerName": "AWS",
          "regionName": "US_GOV_WEST_1",
          "analyticsAutoScaling": {
            "compute": {
              "enabled": true,
              "": "M10",
              "predictiveEnabled": true,
              "scaleDownEnabled": true
            },
            "diskGB": {
              "enabled": true
            }
          },
          "analyticsSpecs": {
            "nodeCount": 42,
            "diskIOPS": 42,
            "ebsVolumeType": "STANDARD",
            "instanceSize": "M10"
          },
          "autoScaling": {
            "compute": {
              "enabled": true,
              "": "M10",
              "predictiveEnabled": true,
              "scaleDownEnabled": true
            },
            "diskGB": {
              "enabled": true
            }
          },
          "readOnlySpecs": {
            "nodeCount": 42,
            "diskIOPS": 42,
            "ebsVolumeType": "STANDARD",
            "instanceSize": "M10"
          }
        }
      ],
      "zoneId": "32b6e34b3d91647abb20e7b8",
      "zoneName": "string"
    }
  ],
  "rootCertType": "ISRGROOTX1",
  "stateName": "IDLE",
  "tags": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "terminationProtectionEnabled": false,
  "versionReleaseSystem": "LTS"
}
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 (409) 
{
  "error": 409,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
  "reason": "Conflict",
  "errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}
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"
}