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

OBTENER /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/processArgs

Devuelve los detalles avanzados de configuración para 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 preocupación de lectura/nivel de confirmación de escritura (write concern), los límites del índice y del oplog, y otras configuraciones de bases de datos. Esta funcionalidad no está disponible para los clústeres gratuitos de M0, M2 y M5 clústeres de nivel compartido, clústeres flex o clústeres sin servidor. Para utilizar este recurso, la cuenta de servicio o la clave API del solicitante debe tener el rol de solo lectura del proyecto.

Clústeres globales

Parámetros de path

  • ID del grupo string Requerido

    string única de 24dígitos hexadecimales que identifica tu proyecto. Usa el endpoint /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 id de tu proyecto. Para los grupos ya existentes, el id de su grupo/proyecto sigue siendo el mismo. El recurso y los endpoints correspondientes utilizan 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 query

  • envelope booleano

    Bandera que indica si la aplicación envuelve 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 remediar esto, establece envelope=true en la query. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como un sobre. La aplicación agrega el parámetro de estado al cuerpo de la respuesta.

    El valor por defecto es false.

  • bonito booleano

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

    El valor por defecto es false.

    Impresión bonita

Respuestas

  • 200 aplicación/json

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • changeStreamOptionsPreAndPostImagesExpireAfterSeconds integer(int32)

      El tiempo mínimo de retención de imagen antes y después en segundos.

      El valor por defecto es -1.

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

      Número de hilos en la partición de origen y en la partición receptora para la migración de fragmentos. El número de hilos no debe exceder la mitad del número total de núcleos de CPU en el clúster particionado.

      Esta opción corresponde a la...
    • 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 por defecto en milisegundos para que las operaciones individuales de lectura se completen.

      Esta opción corresponde a la...
    • defaultReadConcern string

      Nivel por defecto de reconocimiento solicitado a MongoDB para las operaciones de lectura establecidas para este clúster.

      Los clústeres de MongoDB 4.4 tienen por defecto available. Los clústeres de MongoDB 5.0 y versiones posteriores se configuran por defecto en local.

      Los valores son local o available. El valor por defecto es available.

      Esta opción corresponde a la...
    • Nivel de confirmación de escritura (write concern) por defecto string

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

      Esta opción corresponde a la...
    • failIndexKeyTooLong booleano Obsoleto

      Indicador que indica si se pueden insertar o actualizar documentos donde todas las entradas indexadas no superen los 1024 bytes. Si se establece esto como falso, mongod escribe documentos que superan este límite pero no los indexa. Este parámetro se ha eliminado en MongoDB 4.4.

      El valor por defecto es true.

      Esta opción corresponde a la...
    • javascriptEnabled booleano

      Bandera que indica si el clúster permite la ejecución de operaciones que ejecutan JavaScript del lado del servidor. Al utilizar 8.0+, se recomienda desactivar JavaScript del lado del servidor y utilizar operadores de la pipeline de agregación como una alternativa más eficiente.

      Esta opción corresponde a mod...
    • minimumEnabledTlsProtocol 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 utilizan 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 la...
    • noTableScan booleano

      Indicador que señala si el clúster desactiva la ejecución de cualquier query que requiera un escaneo de colección para devolver resultados.

      Esta opción corresponde a la...
    • 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 la...
    • oplogSizeMB entero(int32) | nulo

      Límite de almacenamiento de la oplog del clúster expresado en megabytes. Un valor de null indica que el clúster utiliza el tamaño de oplog por defecto que calcula MongoDB nube.

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

      Se puede establecer en 1 (deshabilitado) o 3 (habilitado). Cuando se establece en 3, Atlas incluirá la salida redactada y anonimizada de $queryStats en los registros de MongoDB. $queryStats la salida no contiene literales ni valores de campo. Activar esta configuración podría afectar el rendimiento de tu clúster.

      Esta opción corresponde a la...
    • 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 la...
    • 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 la...
    • tlsCipherConfigMode 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.

    • transactionLifetimeLimitSeconds integer(int64)

      Duración, en segundos, de las transacciones multi-documento. Atlas considera que las transacciones que superan este límite han caducado y, por lo tanto, las aborta mediante un proceso periódico de limpieza.

      El valor mínimo es 1.

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

    Solicitud incorrecta.

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

      Detalle de solicitud incorrecta.

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

        Describe todas las infracciones en una solicitud de cliente.

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

          Una descripción de por qué el elemento de la 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 arreglo[objeto]

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

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

  • 401 aplicación/json

    No autorizado.

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

      Detalle de solicitud incorrecta.

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

        Describe todas las infracciones en una solicitud de cliente.

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

          Una descripción de por qué el elemento de la 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 arreglo[objeto]

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

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

  • 403 aplicación/json

    Forbidden.

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

      Detalle de solicitud incorrecta.

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

        Describe todas las infracciones en una solicitud de cliente.

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

          Una descripción de por qué el elemento de la 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 arreglo[objeto]

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

    • motivo string

      El mensaje de error de la aplicación se devuelve 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 incorrecta.

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

        Describe todas las infracciones en una solicitud de cliente.

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

          Una descripción de por qué el elemento de la 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 arreglo[objeto]

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

    • motivo string

      El mensaje de error de la aplicación se devuelve 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 incorrecta.

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

        Describe todas las infracciones en una solicitud de cliente.

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

          Una descripción de por qué el elemento de la 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 arreglo[objeto]

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

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

GET /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/processArgs
curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/clusters/{clusterName}/processArgs' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
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,
  "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
}
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"
}