Devolver opciones avanzadas de configuración para un clúster

Obtener /api/atlas/v2/grupos/{ID de grupo}/clústeres/{nombre del clúster}/argumentos del proceso

Devuelve los detalles de configuración avanzada de un clúster en el proyecto especificado. Los clústeres contienen un grupo de hosts que mantienen el mismo conjunto de datos. Los detalles de configuración avanzada incluyen la configuración de lectura/escritura, los límites de índice y registro de operaciones, y otras configuraciones de la base de datos. Esta función no está disponible para clústeres gratuitos M0, clústeres de nivel compartido M2 y M5, clústeres flexibles ni clústeres sin servidor. Para usar este recurso, la cuenta de servicio o la clave de API solicitantes deben tener el rol de solo lectura del proyecto. Versiones obsoletas: v2-{2023-01-01}

Clústeres globales

Parámetros de ruta

  • ID de grupo string Requerido

    Cadena 24hexadecimal única que identifica su proyecto. Utilice el punto de conexión /groups para recuperar todos los proyectos a los que el usuario autenticado tiene acceso.

    NOTA: Grupos y proyectos son términos sinónimos. El ID de tu grupo es el mismo que el de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. El recurso y los puntos finales correspondientes usan el término "grupos".

    El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

  • nombre del clúster string Requerido

    Etiqueta legible por humanos que identifica el clúster.

    El formato debe coincidir con el siguiente patrón: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.

Parámetros de consulta

  • envolvente booleano

    Indicador que indica si la aplicación encapsula la respuesta en un objeto JSON envelope. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como encapsulado. La aplicación añade el parámetro de estado al cuerpo de la respuesta.

    El valor predeterminado es false.

  • bonita booleano

    Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint.

    El valor predeterminado es false.

    Impresión bonita

Respuestas

  • 200 application/vnd.atlas.2024-08-05+json

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • cambiarOpcionesDeTransmisiónPreYPostImágenesExpiranDespuésDeSegundos integer(int32)

      El tiempo mínimo de retención de imágenes previas y posteriores en segundos.

      El valor predeterminado es -1.

      Esta opción corresponde a...
    • Concurrencia de migración de fragmentos integer(int32)

      Número de subprocesos en el fragmento de origen y el fragmento receptor para la migración de fragmentos. El número de subprocesos no debe superar la mitad del número total de núcleos de CPU en el clúster fragmentado.

      Esta opción corresponde a...
    • customOpensslCipherConfigTls12 array[string]

      Lista de conjuntos de cifrado OpenSSL personalizados para TLS 1.2. Este campo solo es válido cuando tlsCipherConfigMode se establece en CUSTOM.

      Los valores son TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 o TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256.

    • customOpensslCipherConfigTls13 array[string]

      Lista de conjuntos de cifrado OpenSSL personalizados para TLS 1.3. Este campo solo es válido cuando tlsCipherConfigMode se establece en CUSTOM.

      No más de 4 elementos. Los valores son TLS_AES_256_GCM_SHA384, TLS_CHACHA20_POLY1305_SHA256, TLS_AES_128_GCM_SHA256 o TLS_AES_128_CCM_SHA256.

    • defaultMaxTimeMS integer(int32)

      Límite de tiempo predeterminado en milisegundos para que se completen las operaciones de lectura individuales.

      Esta opción corresponde a...
    • Preocupación de escritura predeterminada string

      Nivel predeterminado de reconocimiento solicitado a MongoDB para operaciones de escritura cuando el controlador no especifica ninguna.

      Esta opción corresponde a...
    • javascript habilitado booleano

      Marca que indica si el clúster permite la ejecución de operaciones que ejecutan JavaScript en el servidor. Al usar 8.0+, recomendamos deshabilitar JavaScript en el servidor y usar operadores de canalización de agregación como una alternativa más eficiente.

      Esta opción corresponde a mod...
    • protocoloTls mínimo habilitado string

      Versión mínima de Seguridad de la Capa de Transporte (TLS) que el clúster acepta para las conexiones entrantes. Los clústeres que usan TLS 1.0 o 1.1 deberían considerar configurar TLS 1.2 como la versión mínima del protocolo TLS.

      Los valores son TLS1_0, TLS1_1, TLS1_2 o TLS1_3.

      Esta opción corresponde a...
    • noTableScan booleano

      Bandera que indica si el clúster deshabilita la ejecución de cualquier consulta que requiera un escaneo de colección para devolver resultados.

      Esta opción corresponde a...
    • oplogMinRetentionHours número(doble) | nulo

      Ventana mínima de retención del registro de operaciones del clúster, expresada en horas. Un valor nulo indica que el clúster utiliza la ventana mínima de retención predeterminada que calcula MongoDB Cloud.

      Esta opción corresponde a...
    • oplogSizeMB entero(int32) | nulo

      Límite de almacenamiento del registro de operaciones del clúster, expresado en megabytes. Un valor nulo indica que el clúster utiliza el tamaño predeterminado del registro de operaciones calculado por MongoDB Cloud.

      Esta opción corresponde a...
    • Verbosidad del registro de estadísticas de consulta integer(int32)

      Puede configurarse en 1 (deshabilitado) o 3 (habilitado). Si se configura en 3, Atlas incluirá la salida $queryStats redactada y anonimizada en los registros de MongoDB. La salida $queryStats no contiene literales ni valores de campo. Habilitar esta configuración podría afectar el rendimiento del clúster.

      Esta opción corresponde a...
    • sampleRefreshIntervalBIConnector integer(int32)

      Intervalo en segundos en el que el proceso mongosqld vuelve a muestrear los datos para crear su esquema relacional.

      El valor mínimo es 0. El valor por defecto es 0.

      Esta opción corresponde a...
    • Conector BI de tamaño de muestra integer(int32)

      Número de documentos por base de datos a muestrear al recopilar información del esquema.

      El valor mínimo es 0.

      Esta opción corresponde a...
    • Modo de configuración de cifrado tls string

      Modo de configuración del conjunto de cifrado TLS. El modo predeterminado utiliza los conjuntos de cifrado predeterminados. El modo personalizado permite especificar conjuntos de cifrado personalizados para TLS 1.2 y TLS 1.3.

      Los valores son CUSTOM o DEFAULT.

    • Límite de tiempo de vida de la transacción en segundos integer(int64)

      Duración, en segundos, de las transacciones multidocumento. Atlas considera vencidas las transacciones que superan este límite y las cancela mediante un proceso de limpieza periódico.

      El valor mínimo es 1.

      Esta opción corresponde a...
  • 400 aplicación/json

    Solicitud incorrecta.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 401 aplicación/json

    No autorizado.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 403 aplicación/json

    Forbidden.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 404 aplicación/json

    No se encontró.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 500 aplicación/json

    Error Interno del Servidor.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

OBTENER /api/atlas/v2/grupos/{ID de grupo}/clústeres/{nombre del clúster}/argumentos del proceso
atlas api clusters getProcessArgs --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/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.GetGroupClusterProcessArgsApiParams{}
	sdkResp, httpResp, err := client.ClustersApi.
		GetGroupClusterProcessArgsWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs?pretty=true"
Ejemplos de respuestas (200)
{
  "changeStreamOptionsPreAndPostImagesExpireAfterSeconds": -1,
  "chunkMigrationConcurrency": 42,
  "customOpensslCipherConfigTls12": [
    "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
  ],
  "customOpensslCipherConfigTls13": [
    "TLS_AES_256_GCM_SHA384"
  ],
  "defaultMaxTimeMS": 42,
  "defaultWriteConcern": "string",
  "javascriptEnabled": true,
  "minimumEnabledTlsProtocol": "TLS1_0",
  "noTableScan": true,
  "oplogMinRetentionHours": 42.0,
  "oplogSizeMB": 42,
  "queryStatsLogVerbosity": 42,
  "sampleRefreshIntervalBIConnector": 0,
  "sampleSizeBIConnector": 42,
  "tlsCipherConfigMode": "CUSTOM",
  "transactionLifetimeLimitSeconds": 42
}
Ejemplos de respuestas (400)
{
  "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"
}
Ejemplos de respuestas (401)
{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}
Ejemplos de respuestas (403)
{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
Ejemplos de respuestas (404)
{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}
Ejemplos de respuestas (500)
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}