Atualizar opções de configuração avançadas para um cluster
Obsoleto(a)
Atualiza os detalhes de configuração avançada para um cluster no projeto especificado. Os clusters contêm um grupo de hosts que mantêm o mesmo conjunto de dados. Detalhes de configuração avançada incluem read/ preocupação de gravação, limites de índice e oplog e outras configurações do banco de dados . Para utilizar esse recurso, a Conta de Serviço ou Chave de API solicitante deve ter a função de "Gerenciador de cluster do projeto". Este recurso não está disponível para clusters gratuitos do M0, clusters de nível compartilhado do M2 e M5, clusters flexíveis ou clusters sem servidor.
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
Detalhes de configuração avançados para adicionar a um cluster no projeto especificado.
-
O tempo mínimo de retenção pré e pós-imagem em segundos.
O valor padrão é
-1.Esta opção corresponde à... -
Número de segmentos no fragmento de origem e no fragmento de recebimento para migração de partes. O número de segmentos não deve exceder a metade do número total de núcleos da CPU do cluster fragmentado.
Esta opção corresponde à... -
A lista personalizada de conjuntos de cifras OpenSSL para TLS 1.2. Este campo só é válido quando
tlsCipherConfigModeestá definido comoCUSTOM.Os valores são
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384ouTLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256. -
Limite de tempo padrão em milissegundos para a conclusão de operações de leitura individuais.
Esta opção corresponde à... -
Nível padrão de confirmação solicitado pelo MongoDB para operações de leitura definidas para o cluster.
Os clusters MongoDB 4.4 são padronizados como
available. Os clusters do MongoDB 5.0 e posterior são padronizados comolocal.Os valores são
localouavailable. O valor padrão éavailable.Esta opção corresponde à... -
Nível padrão de confirmação de solicitado pelo MongoDB para operações de gravação quando nenhuma é especificada pelo driver.
Esta opção corresponde à... -
Sinalizador que indica se você pode inserir ou atualizar documentos em que todas as entradas indexadas não excedam 1024 bytes. Se você definir essa opção como falsa, o mongod gravará os documentos que excederem esse limite, mas não os indexará. Este parâmetro foi removido a partir do MongoDB 4.4.
O valor padrão é
true.Esta opção corresponde à... -
Sinalizador que indica se o cluster permite a execução de operações que realizam execuções em JavaScript no lado do servidor. Ao usar 8.0+, recomendamos desabilitar o JavaScript do lado do servidor e usar operadores de pipeline de agregação como alternativa de melhor desempenho.
Esta opção corresponde ao mod... -
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_1ouTLS1_2.Esta opção corresponde à... -
Flag que indica se o cluster desativa a execução de qualquer query que exija uma varredura de coleção para retornar resultados.
Esta opção corresponde à... -
Janela mínima de retenção para o oplog do cluster expressa em horas. Um valor nulo indica que o cluster usa a janela de oplog mínima padrão que o MongoDB Cloud calcula.
Esta opção corresponde à... -
Limite de armazenamento do oplog do cluster expresso em megabytes. Um valor nulo indica que o cluster usa o tamanho de oplog padrão que a Nuvem MongoDB calcula.
Esta opção corresponde à... -
Pode ser definido como 1 (desabilitado) ou 3 (habilitado). Quando definido como 3, o Atlas incluirá a saída $queryStats ocultada e anonimizada nos registros do MongoDB. A saída $queryStats não contém literais ou valores de campo. Habilitar essa configuração pode afetar o desempenho do seu cluster.
Esta opção corresponde à... -
Intervalo em segundos no qual o processo mongosqld faz uma nova amostra dos dados para criar seu esquema relacional.
O valor mínimo é
0. O valor padrão é0.Esta opção corresponde à... -
Número de documentos por banco de dados a serem amostrados ao coletar informações de esquema.
O valor mínimo é
0.Esta opção corresponde à... -
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
CUSTOMouDEFAULT. -
Vida útil, em segundos, de transações multidocumento. O Atlas considera as transações que excedem esse limite como expiradas e, portanto, as aborta por meio de um processo de limpeza periódico.
O valor mínimo é
1.Esta opção corresponde à...
atlas api clusters updateProcessArgs --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.UpdateGroupClusterProcessArgsApiParams{}
sdkResp, httpResp, err := client.ClustersApi.
UpdateGroupClusterProcessArgsWithParams(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}/processArgs" \
-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}/processArgs" \
-d '{ <Payload> }'{
"changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
"chunkMigrationConcurrency": 42,
"customOpensslCipherConfigTls12": [
"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
],
"defaultMaxTimeMS": 42,
"defaultReadConcern": "available",
"defaultWriteConcern": "string",
"failIndexKeyTooLong": true,
"javascriptEnabled": true,
"minimumEnabledTlsProtocol": "TLS1_0",
"noTableScan": true,
"oplogMinRetentionHours": 42.0,
"oplogSizeMB": 42,
"queryStatsLogVerbosity": 42,
"sampleRefreshIntervalBIConnector": 0,
"sampleSizeBIConnector": 42,
"tlsCipherConfigMode": "CUSTOM",
"transactionLifetimeLimitSeconds": 42
}{
"changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
"chunkMigrationConcurrency": 42,
"customOpensslCipherConfigTls12": [
"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
],
"defaultMaxTimeMS": 42,
"defaultReadConcern": "available",
"defaultWriteConcern": "string",
"failIndexKeyTooLong": true,
"javascriptEnabled": true,
"minimumEnabledTlsProtocol": "TLS1_0",
"noTableScan": true,
"oplogMinRetentionHours": 42.0,
"oplogSizeMB": 42,
"queryStatsLogVerbosity": 42,
"sampleRefreshIntervalBIConnector": 0,
"sampleSizeBIConnector": 42,
"tlsCipherConfigMode": "CUSTOM",
"transactionLifetimeLimitSeconds": 42
}{
"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": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}