/ /

/ /

Obtener consejo sobre esquemas

Cloud Manager dejará de admitir la Automatización, la Copia de seguridad y la Supervisión para MongoDB 3.6 y 4.0 después del 30de agosto de 2024. Por favor actualiza tu implementación de MongoDB o migra a Atlas.

Proporciona recomendaciones de mejora del esquema para su clúster mediante el análisis de sus 20 colecciones más activas.

URL base: https://cloud.mongodb.com/api/public/v1.0

Resource

GET /groups/{PROJECT-ID}/performanceAdvisor/schemaAdvice

Parámetros de la ruta de solicitud

Parameter	Tipo	Descripción
PROJECT-ID	string	(Obligatorio.) Identificador único del proyecto que es propietario de esta implementación de MongoDB. Grupos y proyectos son términos sinónimos. Tu ID del grupo es el mismo que tu ID de proyecto.

Parámetros de Solicitud Query

Se requiere tanto clusterId como hostId.

Parameter	Tipo	Descripción
bonito	booleano	Indica si el cuerpo de la respuesta debe estar en un prettyprint formato.
envelope	booleano	Indica si se debe o no envolver la respuesta en un sobre.
clusterId	string	Identificador único de un conjunto de réplicas o un clúster fragmentado. Configure este parámetro como `null` si desea obtener asesoramiento sobre el esquema para una instancia independiente que utilice `hostId`.
hostId	string	Identificador único de la instancia autónomo para la que deseas obtener consejo sobre el esquema. Obligatorio si `clusterId` es `null`.

Parámetros del cuerpo de la solicitud

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

Respuesta

Nombre	Tipo	Descripción
`content`	lista de objetos	Contiene acciones sugeridas para la mejora del esquema por namespace.
`content.recommendations`	Objeto	Espacios de nombres con Sugerencias para mejorar el esquema del Performance Advisor.
`content.recommendations` `.affectedNamespaces`	arreglo	Lista de espacios de nombres e información sobre por qué esos espacios de nombres activaron una recomendación.
`content.recommendations` `.affectedNamespaces.namespace`	string	Espacio de nombres de la colección afectada. Este es `null` para la recomendación `REDUCE_NUMBER_OF_NAMESPACES`.
`content.recommendations` `.affectedNamespaces.triggers`	Objeto	Detalles sobre el activador que activó la recomendación.
`content.recommendations` `.affectedNamespaces.triggers` `.description`	string	Descripción del tipo de activador.
`content.recommendations` `.affectedNamespaces.triggers` `.triggerType`	string	Tipo de activador. Las opciones incluyen: `PERCENT_QUERIES_USE_LOOKUP` `NUMBER_OF_QUERIES_USE_LOOKUP` `DOCS_CONTAIN_UNBOUNDED_ARRAY` `NUMBER_OF_NAMESPACES` `DOC_SIZE_TOO_LARGE` `NUM_INDEXES` `QUERIES_CONTAIN_CASE_INSENSITIVE_REGEX`
`content.recommendations` `.description`	string	Descripción de la recomendación especificada.
`content.recommendations` `.recommendation`	string	Tipo de recomendación. Las opciones incluyen: `REDUCE_LOOKUP_OPS` `AVOID_UNBOUNDED_ARRAY` `REDUCE_DOCUMENT_SIZE` `REMOVE_UNNECESSARY_INDEXES` `REDUCE_NUMBER_OF_NAMESPACES` `OPTIMIZE_CASE_INSENSITIVE_REGEX_QUERIES` `OPTIMIZE_TEXT_QUERIES`

Solicitud de ejemplo

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --header 'Accept: application/json' \
 --include \
 --request GET 'https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/performanceAdvisor/schemaAdvice?clusterId={clusterId}&pretty=true'

Respuesta de ejemplo

Encabezado de respuesta

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Respuesta del cuerpo

{
  "content" : {
    "recommendations" : [ {
      "affectedNamespaces" : [ {
        "namespace" : "someDb.someCollection",
        "triggers" : [ {
          "description" : "Documents larger than 2 MB found in the collection(s)    scanned",
          "triggerType" : "DOC_SIZE_TOO_LARGE"
        } ]
      }, {
        "namespace" : "someDb1.someCollection1",
        "triggers" : [ {
          "description" : "Documents larger than 2 MB found in the collection(s)    scanned",
          "triggerType" : "DOC_SIZE_TOO_LARGE"
        } ]
      } ],
      "description" : "Reduce the size of documents",
      "recommendation" : "REDUCE_DOCUMENT_SIZE"
    }, {
      "affectedNamespaces" : [ {
       "namespace" : "someDb2.someCollection2",
        "triggers" : [ {
          "description" : "More than 30 indexes detected in the collection(s) scanned",
          "triggerType" : "NUM_INDEXES"
        } ]
      }, {
        "namespace" : "someDb3.someCollection3",
        "triggers" : [ {
          "description" : "More than 30 indexes detected in the collection(s) scanned",
          "triggerType" : "NUM_INDEXES"
        } ]
      } ],
      "description" : "Remove unnecessary indexes",
      "recommendation" : "REMOVE_UNNECESSARY_INDEXES"
    }, {
      "affectedNamespaces" : [ {
        "namespace" : "someDb4.someCollection4",
        "triggers" : [ {
          "description" : "Arrays with over 10000 entries detected in the collection(s)    scanned",
          "triggerType" : "DOCS_CONTAIN_UNBOUNDED_ARRAY"
        } ]
      } ],
      "description" : "Avoid using unbounded arrays in documents",
      "recommendation" : "AVOID_UNBOUNDED_ARRAY"
    } ]
  },
  "status" : 200
}

Volver

Obtén sugerencias para la eliminación de índices

Latencia de query