Actualizar la configuración del proyecto

PATCH /api/atlas/v1.0/groups/{groupId}/settings

Actualiza la configuración del proyecto especificado. Puedes actualizar cualquiera de las opciones disponibles. MongoDB cloud solo actualiza las opciones indicadas en la solicitud. Para usar este recurso, la Cuenta de servicio solicitante o la clave de API debe tener el rol de Propietario del proyecto.

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})$.

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
aplicación/json

Cuerpo Requerido

Configuraciones para actualizar.

  • isClusterAiAssistantEnabled booleano

    Indicador que señala si el Asistente de Clúster de IA está habilitado para el proyecto especificado.

  • isCollectDatabaseSpecificsStatisticsEnabled booleano

    Indicador que indica si se deben recopilar métricas específicas de la base de datos para el proyecto especificado.

  • isDataExplorerEnabled booleano

    Bandera que indica si se debe activar el Explorador de datos para el proyecto especificado.

  • isDataExplorerGenAIFeaturesEnabled booleano

    Indicador que señala si se debe habilitar el uso de funcionalidades de IA generativa que realizan solicitudes a 3servicios terceros para Data Explorer en el Proyecto especificado.

  • isDataExplorerGenAISampleDocumentPassingEnabled booleano

    Indicador que indica si se debe habilitar el paso de valores de campo de muestra mediante el uso de las funcionalidades de IA generativa en el Data Explorer para el proyecto especificado.

    El valor por defecto es false.

  • isExtendedStorageSizesEnabled booleano

    Indicador que indica si se deben activar tamaños de almacenamiento ampliados para el proyecto especificado.

  • isNativeRerankingEnabled booleano

    Indicador que especifica si se debe habilitar la reclasificación nativa con modelos de IA de Voyage en la canalización de agregación para el proyecto especificado.

  • isPerformanceAdvisorEnabled booleano

    Bandera que indica si se debe habilitar el Asesor de rendimiento y el Generador de perfiles para el proyecto especificado.

  • isRealtimePerformancePanelEnabled booleano

    Bandera que indica si se debe habilitar el Panel de rendimiento en tiempo real para el proyecto especificado.

  • isSchemaAdvisorEnabled booleano

    Indicador que indica si se debe activar el Asesor de Esquemas para el proyecto especificado.

Respuestas

  • 200 aplicación/json

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • isClusterAiAssistantEnabled booleano

      Indicador que señala si el Asistente de Clúster de IA está habilitado para el proyecto especificado.

    • isCollectDatabaseSpecificsStatisticsEnabled booleano

      Indicador que indica si se deben recopilar métricas específicas de la base de datos para el proyecto especificado.

    • isDataExplorerEnabled booleano

      Bandera que indica si se debe activar el Explorador de datos para el proyecto especificado.

    • isDataExplorerGenAIFeaturesEnabled booleano

      Indicador que señala si se debe habilitar el uso de funcionalidades de IA generativa que realizan solicitudes a 3servicios terceros para Data Explorer en el Proyecto especificado.

    • isDataExplorerGenAISampleDocumentPassingEnabled booleano

      Indicador que indica si se debe habilitar el paso de valores de campo de muestra mediante el uso de las funcionalidades de IA generativa en el Data Explorer para el proyecto especificado.

      El valor por defecto es false.

    • isExtendedStorageSizesEnabled booleano

      Indicador que indica si se deben activar tamaños de almacenamiento ampliados para el proyecto especificado.

    • isNativeRerankingEnabled booleano

      Indicador que especifica si se debe habilitar la reclasificación nativa con modelos de IA de Voyage en la canalización de agregación para el proyecto especificado.

    • isPerformanceAdvisorEnabled booleano

      Bandera que indica si se debe habilitar el Asesor de rendimiento y el Generador de perfiles para el proyecto especificado.

    • isRealtimePerformancePanelEnabled booleano

      Bandera que indica si se debe habilitar el Panel de rendimiento en tiempo real para el proyecto especificado.

    • isSchemaAdvisorEnabled booleano

      Indicador que indica si se debe activar el Asesor de Esquemas para el proyecto especificado.

  • 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.

PARCHE /api/atlas/v1.0/grupos/{groupId}/configuraciones
curl \
 --request PATCH 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/settings' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"isClusterAiAssistantEnabled":true,"isCollectDatabaseSpecificsStatisticsEnabled":true,"isDataExplorerEnabled":true,"isDataExplorerGenAIFeaturesEnabled":true,"isDataExplorerGenAISampleDocumentPassingEnabled":false,"isExtendedStorageSizesEnabled":true,"isNativeRerankingEnabled":true,"isPerformanceAdvisorEnabled":true,"isRealtimePerformancePanelEnabled":true,"isSchemaAdvisorEnabled":true}'
Solicitar ejemplos
{
  "isClusterAiAssistantEnabled": true,
  "isCollectDatabaseSpecificsStatisticsEnabled": true,
  "isDataExplorerEnabled": true,
  "isDataExplorerGenAIFeaturesEnabled": true,
  "isDataExplorerGenAISampleDocumentPassingEnabled": false,
  "isExtendedStorageSizesEnabled": true,
  "isNativeRerankingEnabled": true,
  "isPerformanceAdvisorEnabled": true,
  "isRealtimePerformancePanelEnabled": true,
  "isSchemaAdvisorEnabled": true
}
Ejemplos de respuestas (200)
{
  "isClusterAiAssistantEnabled": true,
  "isCollectDatabaseSpecificsStatisticsEnabled": true,
  "isDataExplorerEnabled": true,
  "isDataExplorerGenAIFeaturesEnabled": true,
  "isDataExplorerGenAISampleDocumentPassingEnabled": false,
  "isExtendedStorageSizesEnabled": true,
  "isNativeRerankingEnabled": true,
  "isPerformanceAdvisorEnabled": true,
  "isRealtimePerformancePanelEnabled": true,
  "isSchemaAdvisorEnabled": true
}
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"
}