Menu Docs
Página inicial do Docs
/ /

Cluster Recurso personalizado

Um cluster, gerenciado pelo MongoDB Kubernetes Atlas Operator.

Name
Tipo
Descrição
Obrigatório

apiVersion

string

atlas.generated.mongodb.com/v1

true

kind

string

cluster

true

metadata

objeto

Consulte a documentação do Kubernetes API para os campos do campo metadata.

true

spec

objeto

Especificação do cluster que suporta as seguintes versões:

  • v20250312

No máximo, uma versão spec pode ser especificada. Mais informações: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status Validações:

  • (has(auto.v20250312.``groupId``) && has(auto.``connectionSecretRef``)) || (!has(auto.v20250312.``groupId``): spec.``connectionSecretRef`` deve ser definido se spec.v20250312.``groupId`` estiver definido.

false

status

objeto

somente leitura observado mais recentemente status do cluster para a versão do recurso especificado. Esses dados podem não estar atualizados e são preenchidos pelo sistema. Mais informações: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

false

Especificação do cluster que suporta as seguintes versões:

  • v20250312

No máximo, uma especificação versionada pode ser especificada. Mais informações: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Name
Tipo
Descrição
Obrigatório

connectionSecretRef

objeto

SENSITIVE FIELD Referência a um segredo contendo as credenciais para configurar a conexão com o Atlas.

false

v20250312

objeto

A especificação do recurso de cluster para a versão20250312 v. Validações:

  • (has(auto.''groupId'') && !has(auto.''groupRef'')) || (!has(auto.``groupId``) && has(auto.``groupRef``): groupId e groupRef são mutuamente exclusivos; apenas um deles pode ser definido

false

Campo sensível

Referência a um segredo contendo as credenciais para configurar a conexão com o Atlas.

Name
Tipo
Descrição
Obrigatório

name

string

Nome do segredo que contém as credenciais do Atlas .

false

A especificação do recurso de cluster para a versão v20250312.

Name
Tipo
Descrição
Obrigatório

entry

objeto

Os campos entry da especificação do recurso do cluster. Esses campos podem ser configurados para criar e atualizar clusters.

false

groupId

string

Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para recuperar todos os projetos aos quais o usuário autenticado tem acesso.

Observação

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 pontos de extremidade correspondentes usam o termo grupos.

Validações:

  • self == oldSelf: groupId não pode ser modificado após a criação

false

groupRef

objeto

Uma referência a um recurso "Grupo". O valor de "$.status.v20250312.id" será utilizado para definir "groupId". Mutualmente exclusivo com a propriedade"groupId".

false

Os campos de entrada da especificação do recurso do cluster. Esses campos podem ser configurados para criar e atualizar clusters.

Name
Tipo
Descrição
Obrigatório

acceptDataRisksAndForceReplicaSetReconfig

string

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. MongoDB Os documentos do 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.

false

advancedConfiguration

objeto

Grupo de configurações que define um subconjunto dos detalhes avançados de configuraçã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 true para clusters NVMe. O backup usa backups em nuvem para clusters especializados e backups de cluster compartilhados para clusters inquilinos. Se configurado false para, o cluster não utiliza backups.

false

biConnector

objeto

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

false

clusterType

string

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

false

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.

false

configServerType

string

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

false

diskWarmingMode

string

Seleção de modo de aquecimento do disco.

false

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.

false

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.

false

labels

[] objeto

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. Cluster labels estão obsoletos e serão removidos em uma versão futura. Em vez disso, é altamente recomendável usar tags de recursos.

false

mongoDBEmployeeAccessGrant

objeto

MongoDB nível de acesso concedido ao funcionário e expiração de um cluster.

false

mongoDBMajorVersion

string

MongoDB versão principal do cluster. Defina para a versão binária principal. Na criação: escolha entre as versões disponíveis do MongoDB ou não especifique para o padrão atual recomendado na MongoDB plataforma do Cloud. A versão recomendada é uma versão recente do Suporte a 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 utilize o endpoint API para project LTS versions endpoint. Na atualização: aumente a versão somente em 1 versão principal de cada vez. Se o cluster estiver fixado em uma versão de compatibilidade do recurso MongoDB exatamente uma versão principal abaixo da versão MongoDB atual, a versão MongoDB poderá ser feita o downgrade para a versão principal anterior.

false

name

string

Etiqueta legível por humanos que identifica o cluster.

false

paused

booleano

Sinalizador que indica se o cluster está pausado.

false

pitEnabled

booleano

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

false

redactClientLogData

booleano

Habilite ou desabilite a supressão de registro . Esta configuração configura o mongod ou mongos para redigir qualquer conteúdo de campo de documento de uma mensagem que acompanhe um determinado evento de registro antes do registro. Isso impede que o programa grave dados potencialmente confidenciais armazenados no banco de dados no registro de diagnóstico. Metadados como códigos de erro ou operação, números de linha e nomes de arquivos de origem ainda são visíveis nos registros. Use redactClientLogData em conjunto com Encryption at Rest e TLS/SSL (criptografia de transporte) para auxiliar a conformidade com os requisitosnormativos. Observação: a alteração dessa configuração em um cluster acionará uma reinicialização contínua assim que o cluster for atualizado.

false

replicaSetScalingStrategy

string

Configure este 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 analítica em paralelo com seus nós operacionais. Quando configurado como SEQUENTIAL, o Atlas dimensiona todos os nós sequencialmente. Esse modo é destinado a volumes 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 read-only e analíticos. Esse modo destina-se a volumes de trabalho grandes e dinâmicos 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.

false

replicationSpecs

[] objeto

Lista de configurações que configuram suas regiões de cluster. Essa array tem um objeto por fragmento que representa as configurações de nó em cada fragmento. Para conjuntos de réplicas, há apenas um objeto que representa as configurações dos nós.

false

retainBackups

booleano

Sinalizador que indica se o cluster retém backups.

false

rootCertType

string

Autoridade de certificação raiz que o cluster MongoDB do Atlas utiliza. MongoDB Cloud é compatível com o Internet Security Research Group.

false

tags

[] objeto

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

false

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, MongoDB a nuvem excluirá o cluster.

false

useAwsTimeBasedSnapshotCopyForFastInitialSync

booleano

Sinalizador que indica se as cópias de snapshots baseadas em tempo AWS serão usadas em vez de cópias de snapshots padrão mais lentas durante as sincronizações iniciais rápidas entre regiões do Atlas . Essa sinalização é relevante apenas para clusters que contêm AWS nós.

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.

false

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

Name
Tipo
Descrição
Obrigatório

customOpensslCipherConfigTls12

[]string

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

false

customOpensslCipherConfigTls13

[]string

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

false

minimumEnabledTlsProtocol

string

Versão mínima do Transport Layer Security (TLS) que o cluster aceita para conexões de entrada. Os clusters que usam TLS 1.0 ou 1.1 devem considerar a configuração do TLS 1.2 como a versão mínima do protocolo TLS.

false

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 customizado permite que você especifique conjuntos de cifras customizados para TLS 1.2 e TLS 1.3.

false

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

Name
Tipo
Descrição
Obrigatório

enabled

booleano

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

false

readPreference

string

Nó de 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.

false

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

Name
Tipo
Descrição
Obrigatório

key

string

Chave aplicada para marcar e categorizar este componente.

false

value

string

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

false

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

Name
Tipo
Descrição
Obrigatório

expirationTime

string

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.

true

grantType

string

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

true

links

[] objeto

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

false

Name
Tipo
Descrição
Obrigatório

href

string

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

false

rel

string

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

false

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

Name
Tipo
Descrição
Obrigatório

regionConfigs

[] objeto

Especificações de hardware para nós definidos para uma determinada região. Cada regionConfigs objeto deve ser exclusivo por região e provedor de nuvem dentro replicationSpec do. Cada regionConfigs objeto descreve a prioridade da região nas eleições e o número e tipo de MongoDB nós que MongoDB o Cloud implementa na região. Cada regionConfigs objeto deve ter um analyticsSpecs objeto , electableSpecs objeto ou readOnlySpecs objeto. Os clusters de locatários exigem electableSpecs apenas. Os clusters dedicados podem especificar qualquer uma dessas especificações, mas devem ter pelo menos um electableSpecs objeto dentro de replicationSpec um. Exemplo: Se você replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize M30definir:,replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize defina: M30 se tiver nós elegíveis replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize e: M30 se tiver nós read-only.

false

zoneId

string

String única de 24dígitos hexadecimais que identifica a zona em um cluster global. Este valor pode ser utilizado para configurar políticas de backup do Cluster Global.

false

zoneName

string

etiqueta legível por humanos que descreve a zona à qual esse fragmento pertence em um cluster global. Forneça este valor somente se clusterType : GEOSHARDED mas não selfManagedSharding : true.

false

Provedor de serviços de nuvem no qual a MongoDB Cloud provisiona os hosts.

Name
Tipo
Descrição
Obrigatório

analyticsAutoScaling

objeto

Opções que determinam como esse cluster lida com o dimensionamento de recursos.

false

analyticsSpecs

objeto

As especificações de hardware atuais para nós somente leitura na região.

false

autoScaling

objeto

Opções que determinam como esse cluster lida com o dimensionamento de recursos.

false

backingProviderName

string

Provedor de serviços de nuvem no qual a MongoDB Cloud forneceu o cluster multilocatário. O recurso retorna esse parâmetro quando providerName estiver TENANT e electableSpecs.instanceSize estiver M0, M2 ou M5. Observe que o uso de um instanceSize de M2 ou M5 criará um cluster Flex . O suporte para instanceSize de M2 ou M5 será descontinuado em janeiro de 2026. Recomendamos usar o Create Flex Cluster API para essas configurações daqui para frente.

false

electableSpecs

objeto

Especificações de hardware para todos os nós elegíveis distribuídos na região. Os nós elegíveis podem se tornar os primary e podem habilitar leituras locais. Se você não especificar esta opção, o MongoDB Cloud não distribuirá nós elegíveis na região.

false

priority

inteiro

É dada precedência a esta região quando ocorre uma eleição primária. Se o seu regionConfigs tiver readOnlySpecs apenas, analyticsSpecs ou ambos, defina este valor 0 para. Se você tiver vários regionConfigs objetos (seu cluster é multirregional ou multinuvem), eles deverão ter prioridades em ordem decrescente. O mais alto priority 7é. Exemplo: Se você tiver três regiões, suas prioridades 7 seriam, 6 e 5 respectivamente. Se você adicionasse mais duas regiões para dar suporte a nós elegíveis, as prioridades dessas regiões seriam 4 e 3 respectivamente.

false

providerName

string

Fornecedor de serviços de nuvem no qual o MongoDB Cloud provisiona os hosts. Defina clusters dedicados como AWS, GCP, AZURE ou TENANT.

false

readOnlySpecs

objeto

As especificações de hardware atuais para nós somente leitura na região.

false

regionName

string

Localização física dos seus nós de cluster do MongoDB. A região escolhida pode afetar a latência da rede para os clientes que acessam seus bancos de dados. O nome da região só é retornado na resposta para clusters de região única. Quando o MongoDB Cloud implementa um cluster dedicado, ele verifica se existe uma conexão VPC ou VPC para esse provedor e região. Caso contrário, o MongoDB Cloud os cria como parte do sistema. Ele atribui ao VPC um bloco de roteamento interdomínio sem classes (CIDR). Para limitar uma nova conexão de emparelhamento VPC a um bloco e região de roteamento entre domínios sem classe (CIDR), crie a conexão primeiro. Implemente o cluster após o início da conexão. Os clusters GCP e os clusters de várias regiões exigem uma conexão de emparelhamento VPC para cada região. MongoDB nós podem usar somente a conexão de emparelhamento que reside na mesma região que os nós para se comunicar com o VPC emparelhado.

false

Opções que determinam como esse cluster lida com o dimensionamento de recursos.

Name
Tipo
Descrição
Obrigatório

compute

objeto

Opções que determinam como esse cluster lida com o dimensionamento CPU.

false

diskGB

objeto

Configuração que habilita o dimensionamento automático do disco.

false

Opções que determinam como o cluster lida com o dimensionamento da CPU.

Name
Tipo
Descrição
Obrigatório

enabled

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 replicationSpecs[n].regionConfigs[m].autoScaling.compute.maxInstanceSize.

  • Defina como false para desabilitar o auto-scaling reativo do tamanho da instância.

false

maxInstanceSize

string

Limite de tamanho da instância para o qual seu cluster pode escalar automaticamente.

false

minInstanceSize

string

Limite de tamanho da instância para o qual seu cluster pode escalar automaticamente.

false

scaleDownEnabled

booleano

Sinalizador que indica se o tamanho da instância pode ser reduzido por meio do dimensionamento automático reativo. MongoDB Cloud exige este parâmetro se replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled for true. Se você habilitar esta opção, especifique um valor para replicationSpecs[n].regionConfigs[m].autoScaling.compute.minInstanceSize.

false

Configuração que habilita o dimensionamento automático do disco.

Name
Tipo
Descrição
Obrigatório

enabled

booleano

Sinalizador que indica se este cluster habilita o auto-scaling de disco. A memória máxima permitida para a camada do cluster selecionada e o tamanho do oplog podem limitar o auto-scaling de armazenamento.

false

As especificações de hardware atuais para nós somente leitura na região.

Name
Tipo
Descrição
Obrigatório

diskIOPS

inteiro

Taxa de transferência desejada para armazenamento conectado ao cluster provisionado pelo Azure. Altere este parâmetro se você:

  • definir replicationSpecs[n].regionConfigs[m].providerName : Azure.

  • definir replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize : M40 ou superior, não incluindo Mxx_NVME níveis.

As operações máximas de entrada/saída por segundo (IOPS) dependem do .instanceSize e .diskSizeGB selecionados. Este parâmetro padroniza para o valor de IOPS padrão da camada do agrupamento. Alterar este valor afeta o custo do cluster.

false

diskSizeGB

número

Capacidade de armazenamento de volumes de dados de instância expressos em gigabytes. Aumente esse número para aumentar a capacidade. Este valor deve ser igual para todos os fragmentos e tipos de nó. Este valor não é configurável em clusters M0/M2/M5. MongoDB A nuvem exige esse 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 a possibilidade de atualizar seu cluster para um nível superior.

false

ebsVolumeType

string

Tipo de armazenamento que você deseja anexar ao cluster provisionado por AWS.

  • STANDARD os tipos de volume não podem exceder a taxa padrão de operações de entrada/saída por segundo (IOPS) para o tamanho do volume selecionado.

  • PROVISIONED os tipos de volume devem estar dentro da faixa IOPS permitida para o tamanho do volume selecionado. Você deve configurar esse valor para (PROVISIONED) para clusters NVMe.

false

instanceSize

string

Especificação de hardware para os tamanhos de instância nesta região neste shard. Cada tamanho de instância tem uma capacidade de armazenamento e memória padrão. Os nós elegíveis e os nós read-only (conhecidos como "nós de base") em um único shard devem usar o mesmo tamanho de instância. Os nós de analítica podem ser dimensionados independentemente dos nós básicos dentro de um shard. Tanto os nós de base quanto os nós de analítica podem ser dimensionados independentemente de seus equivalentes em outros shards.

false

nodeCount

inteiro

Número de nós do tipo fornecido para a MongoDB nuvem implantar na região.

false

Opções que determinam como esse cluster lida com o dimensionamento de recursos.

Name
Tipo
Descrição
Obrigatório

compute

objeto

Opções que determinam como esse cluster lida com o dimensionamento CPU.

false

diskGB

objeto

Configuração que habilita o dimensionamento automático do disco.

false

Opções que determinam como o cluster lida com o dimensionamento da CPU.

Name
Tipo
Descrição
Obrigatório

enabled

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 replicationSpecs[n].regionConfigs[m].autoScaling.compute.maxInstanceSize.

  • Defina como false para desabilitar o auto-scaling reativo do tamanho da instância.

false

maxInstanceSize

string

Limite de tamanho da instância para o qual seu cluster pode escalar automaticamente.

false

minInstanceSize

string

Limite de tamanho da instância para o qual seu cluster pode escalar automaticamente.

false

scaleDownEnabled

booleano

Sinalizador que indica se o tamanho da instância pode ser reduzido por meio do dimensionamento automático reativo. MongoDB Cloud exige este parâmetro se replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled for true. Se você habilitar esta opção, especifique um valor para replicationSpecs[n].regionConfigs[m].autoScaling.compute.minInstanceSize.

false

Configuração que habilita o dimensionamento automático do disco.

Name
Tipo
Descrição
Obrigatório

enabled

booleano

Sinalizador que indica se este cluster habilita o auto-scaling de disco. A memória máxima permitida para a camada do cluster selecionada e o tamanho do oplog podem limitar o auto-scaling de armazenamento.

false

Especificações de hardware para todos os nós elegíveis distribuídos na região. Os nós elegíveis podem se tornar os primary e podem habilitar leituras locais. Se você não especificar esta opção, o MongoDB Cloud não implantará nós elegíveis na região.

Name
Tipo
Descrição
Obrigatório

diskIOPS

inteiro

Taxa de transferência desejada para armazenamento conectado ao cluster provisionado pelo Azure. Altere este parâmetro se você:

  • definir replicationSpecs[n].regionConfigs[m].providerName : Azure.

  • definir replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize : M40 ou superior, não incluindo Mxx_NVME níveis.

As operações máximas de entrada/saída por segundo (IOPS) dependem do .instanceSize e .diskSizeGB selecionados. Este parâmetro padroniza para o valor de IOPS padrão da camada do agrupamento. Alterar este valor afeta o custo do cluster.

false

diskSizeGB

número

Capacidade de armazenamento de volumes de dados de instância expressos em gigabytes. Aumente esse número para aumentar a capacidade. Este valor deve ser igual para todos os fragmentos e tipos de nó. Este valor não é configurável em clusters M0/M2/M5. MongoDB A nuvem exige esse 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 a possibilidade de atualizar seu cluster para um nível superior.

false

ebsVolumeType

string

Tipo de armazenamento que você deseja anexar ao cluster provisionado por AWS.

  • STANDARD os tipos de volume não podem exceder a taxa padrão de operações de entrada/saída por segundo (IOPS) para o tamanho do volume selecionado.

  • PROVISIONED os tipos de volume devem estar dentro da faixa IOPS permitida para o tamanho do volume selecionado. Você deve configurar esse valor para (PROVISIONED) para clusters NVMe.

false

effectiveInstanceSize

string

O verdadeiro tamanho da instância do locatário. Isso está presente para oferecer suporte à compatibilidade com versões anteriores para tipos de provedores obsoletos e/ou tamanhos de instâncias.

false

instanceSize

string

Especificação de hardware para as instâncias neste cluster de nível M0/M2/M5.

false

nodeCount

inteiro

Número de nós do tipo fornecido para a MongoDB nuvem implantar na região.

false

As especificações de hardware atuais para nós somente leitura na região.

Name
Tipo
Descrição
Obrigatório

diskIOPS

inteiro

Taxa de transferência desejada para armazenamento conectado ao cluster provisionado pelo Azure. Altere este parâmetro se você:

  • definir replicationSpecs[n].regionConfigs[m].providerName : Azure.

  • definir replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize : M40 ou superior, não incluindo Mxx_NVME níveis.

As operações máximas de entrada/saída por segundo (IOPS) dependem do .instanceSize e .diskSizeGB selecionados. Este parâmetro padroniza para o valor de IOPS padrão da camada do agrupamento. Alterar este valor afeta o custo do cluster.

false

diskSizeGB

número

Capacidade de armazenamento de volumes de dados de instância expressos em gigabytes. Aumente esse número para aumentar a capacidade. Este valor deve ser igual para todos os fragmentos e tipos de nó. Este valor não é configurável em clusters M0/M2/M5. MongoDB A nuvem exige esse 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 a possibilidade de atualizar seu cluster para um nível superior.

false

ebsVolumeType

string

Tipo de armazenamento que você deseja anexar ao cluster provisionado por AWS.

  • STANDARD os tipos de volume não podem exceder a taxa padrão de operações de entrada/saída por segundo (IOPS) para o tamanho do volume selecionado.

  • PROVISIONED os tipos de volume devem estar dentro da faixa IOPS permitida para o tamanho do volume selecionado. Você deve configurar esse valor para (PROVISIONED) para clusters NVMe.

false

instanceSize

string

Especificação de hardware para os tamanhos de instância nesta região neste shard. Cada tamanho de instância tem uma capacidade de armazenamento e memória padrão. Os nós elegíveis e os nós read-only (conhecidos como "nós de base") em um único shard devem usar o mesmo tamanho de instância. Os nós de analítica podem ser dimensionados independentemente dos nós básicos dentro de um shard. Tanto os nós de base quanto os nós de analítica podem ser dimensionados independentemente de seus equivalentes em outros shards.

false

nodeCount

inteiro

Número de nós do tipo fornecido para a MongoDB nuvem implantar na região.

false

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

Name
Tipo
Descrição
Obrigatório

key

string

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

true

value

string

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

true

Uma referência a um recurso "Grupo". O valor de "$.status.v20250312.id" será utilizado para definir "groupId". Mutualmente exclusivo com a propriedade"groupId".

Name
Tipo
Descrição
Obrigatório

name

string

Nome do recurso "Grupo".

false

Status somente leitura observado mais recentemente do cluster para a versão do recurso especificado. Esses dados podem não estar atualizados e são preenchidos pelo sistema. Mais informações: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Name
Tipo
Descrição
Obrigatório

conditions

[] objeto

Representa as últimas observações disponíveis do estado atual de um recurso.

false

v20250312

objeto

O último estado do Atlas observado do recurso do cluster para a versão v20250312.

false

Name
Tipo
Descrição
Obrigatório

status

string

Status da condição, um de verdadeiro, falso, desconhecido.

true

type

string

Tipo de condição.

true

lastTransitionTime

string

Última vez que a condição fez a transição de um status para outro. Formato: data/hora

false

message

string

Um message legível por humanos indicando detalhes sobre a transição.

false

observedGeneration

inteiro

observedGeneration representa o .metadata.generação em que a condição foi definida com base.

false

reason

string

O reason para a última transição da condição.

false

O último estado do Atlas observado do recurso do cluster para a versão v20250312.

Name
Tipo
Descrição
Obrigatório

advancedConfiguration

objeto

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

false

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.

false

configServerType

string

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

false

connectionStrings

objeto

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

false

createDate

string

Data e hora em que MongoDB Cloud criou este cluster. Este parâmetro expressa seu valor no formato ISO 8601 em UTC.

false

effectiveReplicationSpecs

[] objeto

Lista de configurações que representam o estado real do cluster. É somente leitura e sempre retornado na resposta. Ele reflete a configuração atual do cluster, que pode ser diferente de replicationSpecs devido a alterações gerenciadas pelo sistema.

false

featureCompatibilityVersion

string

Versão de compatibilidade de recursos do cluster. Isso sempre aparecerá, independentemente de FCV estar fixado.

false

featureCompatibilityVersionExpirationDate

string

Data de expiração da versão de compatibilidade de recursos. Só aparecerá se FCV estiver fixado. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC.

false

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.

false

groupId

string

String exclusiva de 24 caracteres hexadecimais que identifica o projeto.

false

id

string

String exclusiva de 24 caracteres hexadecimais que identifica o cluster.

false

internalClusterRole

string

Classificação interna da função do cluster. Valores possíveis: NONE (cluster de usuário regular), SYSTEM_CLUSTER (cluster do sistema para backup), INTERNAL_SHADOW_CLUSTER (cluster de sombra de uso interno para teste).

false

mongoDBEmployeeAccessGrant

objeto

MongoDB nível de acesso concedido ao funcionário e expiração de um cluster.

false

mongoDBVersion

string

Versão do MongoDB que o cluster executa.

false

redactClientLogData

booleano

Habilite ou desabilite a supressão de registro . Esta configuração configura o mongod ou mongos para redigir qualquer conteúdo de campo de documento de uma mensagem que acompanhe um determinado evento de registro antes do registro. Isso impede que o programa grave dados potencialmente confidenciais armazenados no banco de dados no registro de diagnóstico. Metadados como códigos de erro ou operação, números de linha e nomes de arquivos de origem ainda são visíveis nos registros. Use redactClientLogData em conjunto com Encryption at Rest e TLS/SSL (criptografia de transporte) para auxiliar a conformidade com os requisitosnormativos. Observação: a alteração dessa configuração em um cluster acionará uma reinicialização contínua assim que o cluster for atualizado.

false

replicaSetScalingStrategy

string

Configure este 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 analítica em paralelo com seus nós operacionais. Quando configurado como SEQUENTIAL, o Atlas dimensiona todos os nós sequencialmente. Esse modo é destinado a volumes 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 read-only e analíticos. Esse modo destina-se a volumes de trabalho grandes e dinâmicos 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.

false

retainBackups

booleano

Sinalizador que indica se o cluster retém backups.

false

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 do UI ou 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 IP lista de acesso e os DB usuários estejam configurados antes de tentar se conectar.

  • UPDATING: Uma alteração solicitada por meio de UI, API, AutoScaling ou outra atividade agendada 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.

false

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

Name
Tipo
Descrição
Obrigatório

customOpensslCipherConfigTls12

[]string

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

false

customOpensslCipherConfigTls13

[]string

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

false

minimumEnabledTlsProtocol

string

Versão mínima do Transport Layer Security (TLS) que o cluster aceita para conexões de entrada. Os clusters que usam TLS 1.0 ou 1.1 devem considerar a configuração do TLS 1.2 como a versão mínima do protocolo TLS.

false

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 customizado permite que você especifique conjuntos de cifras customizados para TLS 1.2 e TLS 1.3.

false

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

Name
Tipo
Descrição
Obrigatório

awsPrivateLink

map[string]string

Connection strings privadas com reconhecimento de endpoints que usam clusters hospedados em AWScom 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 os nomes da chave.

false

awsPrivateLinkSrv

map[string]string

Connection strings privadas com reconhecimento de endpoints que usam clusters hospedados em AWScom 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 os nomes da chave. 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.

false

private

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 Recurso Uniforme (URI), você não precisará anexar a lista de sementes ou alterar o URI se os nós mudarem. Use este formato URI se o seu driver suportar. Caso contrário, use connectionStrings.private. Para clusters do Amazon Web Services (AWS), esse recurso retorna esse parâmetro somente se você habilitar DNSpersonalizado.

false

privateEndpoint

[] 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.

false

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 SistemaDNS de Nomes de Domínio (). Esta lista sincroniza com os nós em um cluster. Se a string de conexão usar este formato de Identificador de recursoURI uniforme (), você não precisará anexar a lista de sementes nem alterar o Identificador de recursoURI uniforme () se os nós forem alterados. Use este formato de Identificador de recursoURI uniforme () se o driver suportar. Caso contrário,connectionStrings.private use. Para clusters do Amazon Web ServicesAWS (), esse parâmetro retornará somente se você habilitar o DNS personalizado.

false

standard

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://.

false

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://.

false

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.

Name
Tipo
Descrição
Obrigatório

connectionString

string

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

false

endpoints

[] objeto

Lista que contém o endpoints privado por meio do qual você se conecta ao MongoDB Cloud quando usa connectionStrings.privateEndpoint[n].connectionString ou connectionStrings.privateEndpoint[n].srvConnectionString.

false

srvConnectionString

string

string de conexão privada com reconhecimento de endpoint que usa o protocolo mongodb+srv:// para se conectar à MongoDB nuvem 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 recurso uniforme (URI), você não precisará anexar a lista de sementes ou alterar o Identificador de recurso uniforme (URI) se os nós forem alterados. Use esse formato de Identificador de recurso uniforme (URI) se seu aplicação suportar. Caso contrário, use connectionStrings.privateEndpoint[n].connectionString.

false

srvShardOptimizedConnectionString

string

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

false

type

string

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

false

Detalhes de um endpoint privado implantado para este cluster.

Name
Tipo
Descrição
Obrigatório

endpointId

string

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

false

providerName

string

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

false

region

string

Região onde o endpoint privado está implantado.

false

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

Name
Tipo
Descrição
Obrigatório

id

string

String única de 24dígitos hexadecimais que identifica o objeto de replicação de um shard em um cluster. Se você incluir as configurações de replicação de shard existentes na solicitação, deverá especificar esse parâmetro. Se você adicionar um novo shard a um cluster existente, poderá especificar este parâmetro. A solicitação exclui todos os shards existentes no Cluster que você exclui da solicitação. Isso corresponde ao Fragmento ID exibido no UI.

false

regionConfigs

[] objeto

Especificações de hardware para nós definidos para uma determinada região. Cada regionConfigs objeto deve ser exclusivo por região e provedor de nuvem dentro replicationSpec do. Cada regionConfigs objeto descreve a prioridade da região nas eleições e o número e tipo de MongoDB nós que MongoDB o Cloud implementa na região. Cada regionConfigs objeto deve ter um analyticsSpecs objeto , electableSpecs objeto ou readOnlySpecs objeto. Os clusters de locatários exigem electableSpecs apenas. Os clusters dedicados podem especificar qualquer uma dessas especificações, mas devem ter pelo menos um electableSpecs objeto dentro de replicationSpec um. Exemplo: Se você replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize M30definir:,replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize defina: M30 se tiver nós elegíveis replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize e: M30 se tiver nós read-only.

false

zoneId

string

String única de 24dígitos hexadecimais que identifica a zona em um cluster global. Este valor pode ser utilizado para configurar políticas de backup do Cluster Global.

false

zoneName

string

etiqueta legível por humanos que descreve a zona à qual esse fragmento pertence em um cluster global. Forneça este valor somente se clusterType : GEOSHARDED mas não selfManagedSharding : true.

false

Provedor de serviços de nuvem no qual a MongoDB Cloud provisiona os hosts.

Name
Tipo
Descrição
Obrigatório

analyticsAutoScaling

objeto

Opções que determinam como esse cluster lida com o dimensionamento de recursos.

false

analyticsSpecs

objeto

As especificações de hardware atuais para nós somente leitura na região.

false

autoScaling

objeto

Opções que determinam como esse cluster lida com o dimensionamento de recursos.

false

backingProviderName

string

Provedor de serviços de nuvem no qual a MongoDB Cloud forneceu o cluster multilocatário. O recurso retorna esse parâmetro quando providerName estiver TENANT e electableSpecs.instanceSize estiver M0, M2 ou M5. Observe que o uso de um instanceSize de M2 ou M5 criará um cluster Flex . O suporte para instanceSize de M2 ou M5 será descontinuado em janeiro de 2026. Recomendamos usar o Create Flex Cluster API para essas configurações daqui para frente.

false

effectiveAnalyticsSpecs

objeto

As especificações de hardware atuais para nós somente leitura na região.

false

effectiveElectableSpecs

objeto

As especificações de hardware atuais para nós somente leitura na região.

false

effectiveReadOnlySpecs

objeto

As especificações de hardware atuais para nós somente leitura na região.

false

electableSpecs

objeto

Especificações de hardware para todos os nós elegíveis distribuídos na região. Os nós elegíveis podem se tornar os primary e podem habilitar leituras locais. Se você não especificar esta opção, o MongoDB Cloud não distribuirá nós elegíveis na região.

false

priority

inteiro

É dada precedência a esta região quando ocorre uma eleição primária. Se o seu regionConfigs tiver readOnlySpecs apenas, analyticsSpecs ou ambos, defina este valor 0 para. Se você tiver vários regionConfigs objetos (seu cluster é multirregional ou multinuvem), eles deverão ter prioridades em ordem decrescente. O mais alto priority 7é. Exemplo: Se você tiver três regiões, suas prioridades 7 seriam, 6 e 5 respectivamente. Se você adicionasse mais duas regiões para dar suporte a nós elegíveis, as prioridades dessas regiões seriam 4 e 3 respectivamente.

false

providerName

string

Fornecedor de serviços de nuvem no qual o MongoDB Cloud provisiona os hosts. Defina clusters dedicados como AWS, GCP, AZURE ou TENANT.

false

readOnlySpecs

objeto

As especificações de hardware atuais para nós somente leitura na região.

false

regionName

string

Localização física dos seus nós de cluster do MongoDB. A região escolhida pode afetar a latência da rede para os clientes que acessam seus bancos de dados. O nome da região só é retornado na resposta para clusters de região única. Quando o MongoDB Cloud implementa um cluster dedicado, ele verifica se existe uma conexão VPC ou VPC para esse provedor e região. Caso contrário, o MongoDB Cloud os cria como parte do sistema. Ele atribui ao VPC um bloco de roteamento interdomínio sem classes (CIDR). Para limitar uma nova conexão de emparelhamento VPC a um bloco e região de roteamento entre domínios sem classe (CIDR), crie a conexão primeiro. Implemente o cluster após o início da conexão. Os clusters GCP e os clusters de várias regiões exigem uma conexão de emparelhamento VPC para cada região. MongoDB nós podem usar somente a conexão de emparelhamento que reside na mesma região que os nós para se comunicar com o VPC emparelhado.

false

Opções que determinam como esse cluster lida com o dimensionamento de recursos.

Name
Tipo
Descrição
Obrigatório

compute

objeto

Opções que determinam como esse cluster lida com o dimensionamento CPU.

false

diskGB

objeto

Configuração que habilita o dimensionamento automático do disco.

false

Opções que determinam como o cluster lida com o dimensionamento da CPU.

Name
Tipo
Descrição
Obrigatório

enabled

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 replicationSpecs[n].regionConfigs[m].autoScaling.compute.maxInstanceSize.

  • Defina como false para desabilitar o auto-scaling reativo do tamanho da instância.

false

maxInstanceSize

string

Limite de tamanho da instância para o qual seu cluster pode escalar automaticamente.

false

minInstanceSize

string

Limite de tamanho da instância para o qual seu cluster pode escalar automaticamente.

false

scaleDownEnabled

booleano

Sinalizador que indica se o tamanho da instância pode ser reduzido por meio do dimensionamento automático reativo. MongoDB Cloud exige este parâmetro se replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled for true. Se você habilitar esta opção, especifique um valor para replicationSpecs[n].regionConfigs[m].autoScaling.compute.minInstanceSize.

false

Configuração que habilita o dimensionamento automático do disco.

Name
Tipo
Descrição
Obrigatório

enabled

booleano

Sinalizador que indica se este cluster habilita o auto-scaling de disco. A memória máxima permitida para a camada do cluster selecionada e o tamanho do oplog podem limitar o auto-scaling de armazenamento.

false

As especificações de hardware atuais para nós somente leitura na região.

Name
Tipo
Descrição
Obrigatório

diskIOPS

inteiro

Taxa de transferência desejada para armazenamento conectado ao cluster provisionado pelo Azure. Altere este parâmetro se você:

  • definir replicationSpecs[n].regionConfigs[m].providerName : Azure.

  • definir replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize : M40 ou superior, não incluindo Mxx_NVME níveis.

As operações máximas de entrada/saída por segundo (IOPS) dependem do .instanceSize e .diskSizeGB selecionados. Este parâmetro padroniza para o valor de IOPS padrão da camada do agrupamento. Alterar este valor afeta o custo do cluster.

false

diskSizeGB

número

Capacidade de armazenamento de volumes de dados de instância expressos em gigabytes. Aumente esse número para aumentar a capacidade. Este valor deve ser igual para todos os fragmentos e tipos de nó. Este valor não é configurável em clusters M0/M2/M5. MongoDB A nuvem exige esse 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 a possibilidade de atualizar seu cluster para um nível superior.

false

ebsVolumeType

string

Tipo de armazenamento que você deseja anexar ao cluster provisionado por AWS.

  • STANDARD os tipos de volume não podem exceder a taxa padrão de operações de entrada/saída por segundo (IOPS) para o tamanho do volume selecionado.

  • PROVISIONED os tipos de volume devem estar dentro da faixa IOPS permitida para o tamanho do volume selecionado. Você deve configurar esse valor para (PROVISIONED) para clusters NVMe.

false

instanceSize

string

Especificação de hardware para os tamanhos de instância nesta região neste shard. Cada tamanho de instância tem uma capacidade de armazenamento e memória padrão. Os nós elegíveis e os nós read-only (conhecidos como "nós de base") em um único shard devem usar o mesmo tamanho de instância. Os nós de analítica podem ser dimensionados independentemente dos nós básicos dentro de um shard. Tanto os nós de base quanto os nós de analítica podem ser dimensionados independentemente de seus equivalentes em outros shards.

false

nodeCount

inteiro

Número de nós do tipo fornecido para a MongoDB nuvem implantar na região.

false

Opções que determinam como esse cluster lida com o dimensionamento de recursos.

Name
Tipo
Descrição
Obrigatório

compute

objeto

Opções que determinam como esse cluster lida com o dimensionamento CPU.

false

diskGB

objeto

Configuração que habilita o dimensionamento automático do disco.

false

Opções que determinam como o cluster lida com o dimensionamento da CPU.

Name
Tipo
Descrição
Obrigatório

enabled

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 replicationSpecs[n].regionConfigs[m].autoScaling.compute.maxInstanceSize.

  • Defina como false para desabilitar o auto-scaling reativo do tamanho da instância.

false

maxInstanceSize

string

Limite de tamanho da instância para o qual seu cluster pode escalar automaticamente.

false

minInstanceSize

string

Limite de tamanho da instância para o qual seu cluster pode escalar automaticamente.

false

scaleDownEnabled

booleano

Sinalizador que indica se o tamanho da instância pode ser reduzido por meio do dimensionamento automático reativo. MongoDB Cloud exige este parâmetro se replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled for true. Se você habilitar esta opção, especifique um valor para replicationSpecs[n].regionConfigs[m].autoScaling.compute.minInstanceSize.

false

Configuração que habilita o dimensionamento automático do disco.

Name
Tipo
Descrição
Obrigatório

enabled

booleano

Sinalizador que indica se este cluster habilita o auto-scaling de disco. A memória máxima permitida para a camada do cluster selecionada e o tamanho do oplog podem limitar o auto-scaling de armazenamento.

false

As especificações de hardware atuais para nós somente leitura na região.

Name
Tipo
Descrição
Obrigatório

diskIOPS

inteiro

Taxa de transferência desejada para armazenamento conectado ao cluster provisionado pelo Azure. Altere este parâmetro se você:

  • definir replicationSpecs[n].regionConfigs[m].providerName : Azure.

  • definir replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize : M40 ou superior, não incluindo Mxx_NVME níveis.

As operações máximas de entrada/saída por segundo (IOPS) dependem do .instanceSize e .diskSizeGB selecionados. Este parâmetro padroniza para o valor de IOPS padrão da camada do agrupamento. Alterar este valor afeta o custo do cluster.

false

diskSizeGB

número

Capacidade de armazenamento de volumes de dados de instância expressos em gigabytes. Aumente esse número para aumentar a capacidade. Este valor deve ser igual para todos os fragmentos e tipos de nó. Este valor não é configurável em clusters M0/M2/M5. MongoDB A nuvem exige esse 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 a possibilidade de atualizar seu cluster para um nível superior.

false

ebsVolumeType

string

Tipo de armazenamento que você deseja anexar ao cluster provisionado por AWS.

  • STANDARD os tipos de volume não podem exceder a taxa padrão de operações de entrada/saída por segundo (IOPS) para o tamanho do volume selecionado.

  • PROVISIONED os tipos de volume devem estar dentro da faixa IOPS permitida para o tamanho do volume selecionado. Você deve configurar esse valor para (PROVISIONED) para clusters NVMe.

false

instanceSize

string

Especificação de hardware para os tamanhos de instância nesta região neste shard. Cada tamanho de instância tem uma capacidade de armazenamento e memória padrão. Os nós elegíveis e os nós read-only (conhecidos como "nós de base") em um único shard devem usar o mesmo tamanho de instância. Os nós de analítica podem ser dimensionados independentemente dos nós básicos dentro de um shard. Tanto os nós de base quanto os nós de analítica podem ser dimensionados independentemente de seus equivalentes em outros shards.

false

nodeCount

inteiro

Número de nós do tipo fornecido para a MongoDB nuvem implantar na região.

false

As especificações de hardware atuais para nós somente leitura na região.

Name
Tipo
Descrição
Obrigatório

diskIOPS

inteiro

Taxa de transferência desejada para armazenamento conectado ao cluster provisionado pelo Azure. Altere este parâmetro se você:

  • definir replicationSpecs[n].regionConfigs[m].providerName : Azure.

  • definir replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize : M40 ou superior, não incluindo Mxx_NVME níveis.

As operações máximas de entrada/saída por segundo (IOPS) dependem do .instanceSize e .diskSizeGB selecionados. Este parâmetro padroniza para o valor de IOPS padrão da camada do agrupamento. Alterar este valor afeta o custo do cluster.

false

diskSizeGB

número

Capacidade de armazenamento de volumes de dados de instância expressos em gigabytes. Aumente esse número para aumentar a capacidade. Este valor deve ser igual para todos os fragmentos e tipos de nó. Este valor não é configurável em clusters M0/M2/M5. MongoDB A nuvem exige esse 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 a possibilidade de atualizar seu cluster para um nível superior.

false

ebsVolumeType

string

Tipo de armazenamento que você deseja anexar ao cluster provisionado por AWS.

  • STANDARD os tipos de volume não podem exceder a taxa padrão de operações de entrada/saída por segundo (IOPS) para o tamanho do volume selecionado.

  • PROVISIONED os tipos de volume devem estar dentro da faixa IOPS permitida para o tamanho do volume selecionado. Você deve configurar esse valor para (PROVISIONED) para clusters NVMe.

false

instanceSize

string

Especificação de hardware para os tamanhos de instância nesta região neste shard. Cada tamanho de instância tem uma capacidade de armazenamento e memória padrão. Os nós elegíveis e os nós read-only (conhecidos como "nós de base") em um único shard devem usar o mesmo tamanho de instância. Os nós de analítica podem ser dimensionados independentemente dos nós básicos dentro de um shard. Tanto os nós de base quanto os nós de analítica podem ser dimensionados independentemente de seus equivalentes em outros shards.

false

nodeCount

inteiro

Número de nós do tipo fornecido para a MongoDB nuvem implantar na região.

false

As especificações de hardware atuais para nós somente leitura na região.

Name
Tipo
Descrição
Obrigatório

diskIOPS

inteiro

Taxa de transferência desejada para armazenamento conectado ao cluster provisionado pelo Azure. Altere este parâmetro se você:

  • definir replicationSpecs[n].regionConfigs[m].providerName : Azure.

  • definir replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize : M40 ou superior, não incluindo Mxx_NVME níveis.

As operações máximas de entrada/saída por segundo (IOPS) dependem do .instanceSize e .diskSizeGB selecionados. Este parâmetro padroniza para o valor de IOPS padrão da camada do agrupamento. Alterar este valor afeta o custo do cluster.

false

diskSizeGB

número

Capacidade de armazenamento de volumes de dados de instância expressos em gigabytes. Aumente esse número para aumentar a capacidade. Este valor deve ser igual para todos os fragmentos e tipos de nó. Este valor não é configurável em clusters M0/M2/M5. MongoDB A nuvem exige esse 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 a possibilidade de atualizar seu cluster para um nível superior.

false

ebsVolumeType

string

Tipo de armazenamento que você deseja anexar ao cluster provisionado por AWS.

  • STANDARD os tipos de volume não podem exceder a taxa padrão de operações de entrada/saída por segundo (IOPS) para o tamanho do volume selecionado.

  • PROVISIONED os tipos de volume devem estar dentro da faixa IOPS permitida para o tamanho do volume selecionado. Você deve configurar esse valor para (PROVISIONED) para clusters NVMe.

false

instanceSize

string

Especificação de hardware para os tamanhos de instância nesta região neste shard. Cada tamanho de instância tem uma capacidade de armazenamento e memória padrão. Os nós elegíveis e os nós read-only (conhecidos como "nós de base") em um único shard devem usar o mesmo tamanho de instância. Os nós de analítica podem ser dimensionados independentemente dos nós básicos dentro de um shard. Tanto os nós de base quanto os nós de analítica podem ser dimensionados independentemente de seus equivalentes em outros shards.

false

nodeCount

inteiro

Número de nós do tipo fornecido para a MongoDB nuvem implantar na região.

false

Especificações de hardware para todos os nós elegíveis distribuídos na região. Os nós elegíveis podem se tornar os primary e podem habilitar leituras locais. Se você não especificar esta opção, o MongoDB Cloud não implantará nós elegíveis na região.

Name
Tipo
Descrição
Obrigatório

diskIOPS

inteiro

Taxa de transferência desejada para armazenamento conectado ao cluster provisionado pelo Azure. Altere este parâmetro se você:

  • definir replicationSpecs[n].regionConfigs[m].providerName : Azure.

  • definir replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize : M40 ou superior, não incluindo Mxx_NVME níveis.

As operações máximas de entrada/saída por segundo (IOPS) dependem do .instanceSize e .diskSizeGB selecionados. Este parâmetro padroniza para o valor de IOPS padrão da camada do agrupamento. Alterar este valor afeta o custo do cluster.

false

diskSizeGB

número

Capacidade de armazenamento de volumes de dados de instância expressos em gigabytes. Aumente esse número para aumentar a capacidade. Este valor deve ser igual para todos os fragmentos e tipos de nó. Este valor não é configurável em clusters M0/M2/M5. MongoDB A nuvem exige esse 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 a possibilidade de atualizar seu cluster para um nível superior.

false

ebsVolumeType

string

Tipo de armazenamento que você deseja anexar ao cluster provisionado por AWS.

  • STANDARD os tipos de volume não podem exceder a taxa padrão de operações de entrada/saída por segundo (IOPS) para o tamanho do volume selecionado.

  • PROVISIONED os tipos de volume devem estar dentro da faixa IOPS permitida para o tamanho do volume selecionado. Você deve configurar esse valor para (PROVISIONED) para clusters NVMe.

false

effectiveInstanceSize

string

O verdadeiro tamanho da instância do locatário. Isso está presente para oferecer suporte à compatibilidade com versões anteriores para tipos de provedores obsoletos e/ou tamanhos de instâncias.

false

instanceSize

string

Especificação de hardware para as instâncias neste cluster de nível M0/M2/M5.

false

nodeCount

inteiro

Número de nós do tipo fornecido para a MongoDB nuvem implantar na região.

false

As especificações de hardware atuais para nós somente leitura na região.

Name
Tipo
Descrição
Obrigatório

diskIOPS

inteiro

Taxa de transferência desejada para armazenamento conectado ao cluster provisionado pelo Azure. Altere este parâmetro se você:

  • definir replicationSpecs[n].regionConfigs[m].providerName : Azure.

  • definir replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize : M40 ou superior, não incluindo Mxx_NVME níveis.

As operações máximas de entrada/saída por segundo (IOPS) dependem do .instanceSize e .diskSizeGB selecionados. Este parâmetro padroniza para o valor de IOPS padrão da camada do agrupamento. Alterar este valor afeta o custo do cluster.

false

diskSizeGB

número

Capacidade de armazenamento de volumes de dados de instância expressos em gigabytes. Aumente esse número para aumentar a capacidade. Este valor deve ser igual para todos os fragmentos e tipos de nó. Este valor não é configurável em clusters M0/M2/M5. MongoDB A nuvem exige esse 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 a possibilidade de atualizar seu cluster para um nível superior.

false

ebsVolumeType

string

Tipo de armazenamento que você deseja anexar ao cluster provisionado por AWS.

  • STANDARD os tipos de volume não podem exceder a taxa padrão de operações de entrada/saída por segundo (IOPS) para o tamanho do volume selecionado.

  • PROVISIONED os tipos de volume devem estar dentro da faixa IOPS permitida para o tamanho do volume selecionado. Você deve configurar esse valor para (PROVISIONED) para clusters NVMe.

false

instanceSize

string

Especificação de hardware para os tamanhos de instância nesta região neste shard. Cada tamanho de instância tem uma capacidade de armazenamento e memória padrão. Os nós elegíveis e os nós read-only (conhecidos como "nós de base") em um único shard devem usar o mesmo tamanho de instância. Os nós de analítica podem ser dimensionados independentemente dos nós básicos dentro de um shard. Tanto os nós de base quanto os nós de analítica podem ser dimensionados independentemente de seus equivalentes em outros shards.

false

nodeCount

inteiro

Número de nós do tipo fornecido para a MongoDB nuvem implantar na região.

false

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

Name
Tipo
Descrição
Obrigatório

expirationTime

string

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.

true

grantType

string

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

true

links

[] objeto

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

false

Name
Tipo
Descrição
Obrigatório

href

string

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

false

rel

string

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

false

Voltar

Grupo

Nesta página