Actualizar la configuración del proyecto

PARCHE /api/atlas/v2/grupos/{groupId}/configuración

Actualiza la configuración del proyecto especificado. Puede actualizar cualquiera de las opciones disponibles. MongoDB Cloud solo actualiza las opciones proporcionadas en la solicitud. Para usar este recurso, la cuenta de servicio o la clave API solicitantes deben tener el rol de propietario del proyecto.

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

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
application/vnd.atlas.2023-01-01+json

Cuerpo Requerido

Configuraciones para actualizar.

  • estáRecopiladoDeDatosEspecíficosEstadísticasHabilitadas booleano

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

  • estáDataExplorerEnabled booleano

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

  • isDataExplorerGenAIAFeaturesEnabled booleano

    Bandera que indica si se debe habilitar el uso de funciones de IA generativa que realizan solicitudes a 3servicios de terceros en Data Explorer para el proyecto especificado.

  • está habilitado el paso de documentos de muestra de DataExplorerGenAI 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 predeterminado es false.

  • estáExtendedStorageSizesEnabled booleano

    Bandera que indica si se deben habilitar tamaños de almacenamiento extendidos 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.

  • estáRealtimePerformancePanelEnabled booleano

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

  • isSchemaAdvisorEnabled booleano

    Bandera que indica si se debe habilitar el Asesor de esquemas para el proyecto especificado.

Respuestas

  • 200 application/vnd.atlas.2023-01-01+json

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • estáRecopiladoDeDatosEspecíficosEstadísticasHabilitadas booleano

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

    • estáDataExplorerEnabled booleano

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

    • isDataExplorerGenAIAFeaturesEnabled booleano

      Bandera que indica si se debe habilitar el uso de funciones de IA generativa que realizan solicitudes a 3servicios de terceros en Data Explorer para el proyecto especificado.

    • está habilitado el paso de documentos de muestra de DataExplorerGenAI 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 predeterminado es false.

    • estáExtendedStorageSizesEnabled booleano

      Bandera que indica si se deben habilitar tamaños de almacenamiento extendidos 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.

    • estáRealtimePerformancePanelEnabled booleano

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

    • isSchemaAdvisorEnabled booleano

      Bandera que indica si se debe habilitar 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 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.

PARCHE /api/atlas/v2/grupos/{groupId}/configuraciones
atlas api projects updateGroupSettings --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20241113001/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.UpdateGroupSettingsApiParams{}
	sdkResp, httpResp, err := client.ProjectsApi.
		UpdateGroupSettingsWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2024-11-13+json" \
  --header "Content-Type: application/json" \
  -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings" \
  -d '{ <Payload> }'
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2024-11-13+json" \
  --header "Content-Type: application/json" \
  -X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/settings" \
  -d '{ <Payload> }'
Solicitar ejemplos
{
  "isCollectDatabaseSpecificsStatisticsEnabled": true,
  "isDataExplorerEnabled": true,
  "isDataExplorerGenAIFeaturesEnabled": true,
  "isDataExplorerGenAISampleDocumentPassingEnabled": false,
  "isExtendedStorageSizesEnabled": true,
  "isPerformanceAdvisorEnabled": true,
  "isRealtimePerformancePanelEnabled": true,
  "isSchemaAdvisorEnabled": true
}
Ejemplos de respuestas (200)
{
  "isCollectDatabaseSpecificsStatisticsEnabled": true,
  "isDataExplorerEnabled": true,
  "isDataExplorerGenAIFeaturesEnabled": true,
  "isDataExplorerGenAISampleDocumentPassingEnabled": false,
  "isExtendedStorageSizesEnabled": 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"
}