Atualizar um cluster em um projeto
Obsoleto(a)
Atualiza os detalhes de um cluster no projeto especificado. Os clusters contêm um grupo de hosts que mantêm o mesmo conjunto de dados. Esse recurso pode atualizar clusters com fragmentos de tamanho assimétrico. Para atualizar a proteção de encerramento de um cluster, a conta de serviço ou a chave de API solicitante deve ter a função de proprietário do projeto. Para todas as outras atualizações, a conta de Serviço ou a chave de API solicitante deve ter a função de gerente de cluster do projeto. Não é possível modificar um cluster pausado (paused : true). Você deve chamar esse ponto de extremidade para definir paused : false. Depois que esse ponto de extremidade responder com paused : false, você poderá chamá-lo novamente com as alterações que deseja fazer no cluster. Este recurso não está disponível para clusters sem servidor.
Cabeçalhos
-
Controla como os campos de especificação de hardware são retornados na resposta após as atualizações do cluster. Quando definido como verdadeiro, retorna os valores originais especificados pelo cliente e fornece campos efetivos separados mostrando os valores operacionais atuais. Quando falso (padrão), os campos de especificação de hardware mostram diretamente os valores operacionais atuais. Observação: ao usar esse cabeçalho com o autoscaling ativado, o MongoDB ignora as alterações replicationSpecs durante as atualizações. Para substituir intencionalmente os replicationSpecs, desabilite esse cabeçalho.
O valor padrão é
false.
parâmetros de caminho
-
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})$. -
Etiqueta legível por humanos que identifica o cluster.
O formato deve corresponder ao seguinte padrão:
^[a-zA-Z0-9][a-zA-Z0-9-]*$.
parâmetros de query
-
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. -
Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
O valor padrão é
false.Prettyprint
corpo, corpo
Obrigatório
Cluster a ser atualizado no projeto especificado.
-
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.
Reconfigurando um conjunto de réplicas du... -
Grupo de configurações que define um subconjunto dos detalhes avançados de configuração.
-
Faixa de tamanhos de instâncias para os quais seu cluster pode ser dimensionado.
Escalonamento automático de cluster -
Sinalizador que indica se o cluster pode executar backups. Se definido como
true, o cluster poderá executar backups. Você deve configurar este valor paratruepara clusters NVMe. O backup usa backups em nuvem para clusters dedicados e backups de cluster compartilhado para clusters de locatário. Se definido comofalse, o cluster não usará backups do MongoDB Cloud. -
Configurações necessárias para configurar o MongoDB Connector for Business Intelligence para esse cluster.
MongoDB Connector for Business... -
Configuração de nós que compõem o cluster.
Os valores são
REPLICASET,SHARDEDouGEOSHARDED. -
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_MANAGEDouFIXED_TO_DEDICATED. O valor padrão éATLAS_MANAGED.Configuração de cluster fragmentado MongoDB ... -
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.
O valor mínimo é
10, o valor máximo é4096. -
Seleção de modo de aquecimento do disco.
Os valores são
FULLY_WARMEDouVISIBLE_EARLIER. O valor padrão éFULLY_WARMED.Reduza o aquecimento do disco secundário... -
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
M10ou superior e"backupEnabled" : falseou ser totalmente omitida.Os valores são
NONE,AWS,AZUREouGCP.Encryption at Rest usando Custo... -
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 -
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 -
Funcionário do MongoDB recebeu nível de acesso e expiração para um cluster.
-
Versão principal do MongoDB do cluster.
Na criação: escolha entre as versões disponíveis do MongoDB ou deixe sem especificar o padrão atual recomendado na plataforma MongoDB Cloud. A versão recomendada é uma versão recente de suporte de longo prazo. Não é garantido que o padrão seja a versão lançada mais recentemente durante todo o ciclo de lançamento. Para versões disponíveis em um projeto específico, consulte a documentação vinculada ou use o ponto de extremidade da API para o ponto de extremidade de versões LTS do projeto.
Na atualização: aumente a versão somente na versão principal 1 por vez. Se o cluster estiver fixado em uma versão de compatibilidade de recursos do MongoDB, exatamente uma versão principal abaixo da versão atual do MongoDB, a versão do MongoDB poderá ser rebaixada para a versão principal anterior.
Versões do MongoDB disponíveis em... -
Versão do MongoDB que o cluster executa.
O formato deve corresponder ao seguinte padrão:
([\d]+\.[\d]+\.[\d]+). -
Etiqueta legível por humanos que identifica o cluster.
O formato deve corresponder ao seguinte padrão:
^[a-zA-Z0-9][a-zA-Z0-9-]*$. -
Número de fragmentos até 50 a serem implantados em um cluster fragmentado. O recurso retorna
1para indicar um conjunto de réplica e valores de2e superior para indicar um cluster fragmentado. O valor retornado é igual ao número de fragmentos do cluster.O valor mínimo é
1, o valor máximo é50. O valor padrão é1.Fragmentação -
Sinalizador que indica se o cluster está pausado.
-
Sinalizador que indica se o cluster usa backups contínuos na nuvem.
Backups contínuos da nuvem -
Sinalizador que indica se o cluster M10 ou superior pode executar backups em nuvem. Se configurado para
true, o cluster poderá executar backups. Se isso e backupEnabled estiverem definidos comofalse, o cluster não usará backups do MongoDB Cloud. -
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_TYPEouNODE_TYPE. O valor padrão éWORKLOAD_TYPE.Modifique o dimensionamento do conjunto de réplicas... -
Número de nós que pertencem ao conjunto de réplicas. Cada nó mantém uma cópia dos seus bancos de dados, proporcionando uma alta disponibilidade e uma redundância de dados. Em vez disso, use replicationSpecs.
Os valores são
3,5ou7. O valor padrão é3. -
Local físico onde o MongoDB Cloud provisiona nós de cluster.
-
Lista de configurações que definem suas regiões de cluster.
- Para clusters globais, cada objeto na array representa uma zona onde o MongoDB Cloud implanta seus nós de clusters.
- Para conjuntos de réplicas e clusters fragmentados não globais, o objeto único representa onde o MongoDB Cloud implanta seus nós de clusters.
-
Autoridade de certificado raiz que o cluster MongoDB Atlas utiliza. O MongoDB Cloud é compatível com oInternet Segurança Research Group.
O valor é
ISRGROOTX1. O valor padrão éISRGROOTX1. -
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 comofalse, o MongoDB Cloud excluirá o cluster.O valor padrão é
false. -
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
LTSouCONTINUOUS. O valor padrão éLTS.
atlas api clusters updateCluster --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20230101001/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.UpdateGroupClusterApiParams{}
sdkResp, httpResp, err := client.ClustersApi.
UpdateGroupClusterWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2023-01-01+json" \
--header "Content-Type: application/json" \
-X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" \
-d '{ <Payload> }'curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2023-01-01+json" \
--header "Content-Type: application/json" \
-X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" \
-d '{ <Payload> }'# Headers
Use-Effective-Instance-Fields: false
# Payload
{
"acceptDataRisksAndForceReplicaSetReconfig": "2025-05-04T09:42:00Z",
"advancedConfiguration": {
"customOpensslCipherConfigTls12": [
"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
],
"minimumEnabledTlsProtocol": "TLS1_0",
"tlsCipherConfigMode": "CUSTOM"
},
"autoScaling": {
"compute": {
"enabled": false,
"scaleDownEnabled": false
},
"diskGBEnabled": false
},
"backupEnabled": true,
"biConnector": {
"enabled": true,
"readPreference": "PRIMARY"
},
"clusterType": "REPLICASET",
"configServerManagementMode": "ATLAS_MANAGED",
"diskSizeGB": 42.0,
"diskWarmingMode": "FULLY_WARMED",
"encryptionAtRestProvider": "NONE",
"globalClusterSelfManagedSharding": true,
"labels": [
{
"key": "string",
"value": "string"
}
],
"mongoDBEmployeeAccessGrant": {
"expirationTime": "2025-05-04T09:42:00Z",
"grantType": "CLUSTER_DATABASE_LOGS"
},
"mongoDBMajorVersion": "5.0",
"mongoDBVersion": "5.0.25",
"name": "string",
"numShards": 1,
"paused": true,
"pitEnabled": true,
"providerBackupEnabled": true,
"providerSettings": {
"providerName": "AWS",
"autoScaling": {
"compute": {
"maxInstanceSize": "M10",
"minInstanceSize": "M10"
}
},
"diskIOPS": 42,
"encryptEBSVolume": true,
"instanceSizeName": "M10",
"regionName": "US_GOV_WEST_1",
"volumeType": "STANDARD"
},
"replicaSetScalingStrategy": "WORKLOAD_TYPE",
"replicationFactor": 3,
"replicationSpec": {
"additionalProperty1": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
},
"additionalProperty2": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
}
},
"replicationSpecs": [
{
"id": "32b6e34b3d91647abb20e7b8",
"numShards": 1,
"regionsConfig": {
"additionalProperty1": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
},
"additionalProperty2": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
}
},
"zoneName": "string"
}
],
"rootCertType": "ISRGROOTX1",
"tags": [
{
"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false,
"versionReleaseSystem": "LTS"
}{
"acceptDataRisksAndForceReplicaSetReconfig": "2025-05-04T09:42:00Z",
"advancedConfiguration": {
"customOpensslCipherConfigTls12": [
"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
],
"minimumEnabledTlsProtocol": "TLS1_0",
"tlsCipherConfigMode": "CUSTOM"
},
"autoScaling": {
"compute": {
"enabled": false,
"scaleDownEnabled": false
},
"diskGBEnabled": false
},
"backupEnabled": true,
"biConnector": {
"enabled": true,
"readPreference": "PRIMARY"
},
"clusterType": "REPLICASET",
"configServerManagementMode": "ATLAS_MANAGED",
"configServerType": "DEDICATED",
"connectionStrings": {
"awsPrivateLink": {
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"awsPrivateLinkSrv": {
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"private": "string",
"privateEndpoint": [
{
"connectionString": "string",
"endpoints": [
{
"endpointId": "string",
"providerName": "AWS",
"region": "string"
}
],
"srvConnectionString": "string",
"srvShardOptimizedConnectionString": "string",
"type": "MONGOD"
}
],
"privateSrv": "string",
"standard": "string",
"standardSrv": "string"
},
"createDate": "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": "5.0",
"mongoDBVersion": "5.0.25",
"mongoURI": "string",
"mongoURIUpdated": "2025-05-04T09:42:00Z",
"mongoURIWithOptions": "string",
"name": "string",
"numShards": 1,
"paused": true,
"pitEnabled": true,
"providerBackupEnabled": true,
"providerSettings": {
"providerName": "AWS",
"autoScaling": {
"compute": {
"maxInstanceSize": "M10",
"minInstanceSize": "M10"
}
},
"diskIOPS": 42,
"encryptEBSVolume": true,
"instanceSizeName": "M10",
"regionName": "US_GOV_WEST_1",
"volumeType": "STANDARD"
},
"replicaSetScalingStrategy": "WORKLOAD_TYPE",
"replicationFactor": 3,
"replicationSpec": {
"additionalProperty1": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
},
"additionalProperty2": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
}
},
"replicationSpecs": [
{
"id": "32b6e34b3d91647abb20e7b8",
"numShards": 1,
"regionsConfig": {
"additionalProperty1": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
},
"additionalProperty2": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
}
},
"zoneName": "string"
}
],
"rootCertType": "ISRGROOTX1",
"srvAddress": "string",
"stateName": "IDLE",
"tags": [
{
"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false,
"versionReleaseSystem": "LTS"
}{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"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"
}{
"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"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}