Devuelve los índices que recomienda el Asesor de rendimiento. El Asesor de rendimiento supervisa las consultas que MongoDB considera lentas y sugiere nuevos índices para mejorar el rendimiento de las consultas. Para utilizar este recurso, la cuenta de servicio o clave de API que realiza la solicitud debe tener el rol de solo lectura del proyecto.
Parámetros de path
-
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})$. -
Combinación de host y puerto que sirve al proceso MongoDB. El host debe ser el nombre de host, el FQDN, la dirección IPv4 o la dirección IPv6 del host que ejecuta el proceso MongoDB (
mongodomongos). El puerto debe ser el puerto IANA en el que el proceso MongoDB recibe las solicitudes.El formato debe coincidir con el siguiente patrón:
^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?(\:[0-9]{4,5})$.
Parámetros de query
-
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. -
Bandera que indica si la respuesta devuelve el número total de elementos (
totalCount) en la respuesta.El valor por defecto es
true. -
Número de elementos que la respuesta retorna por página.
El valor mínimo es
1, el valor máximo es500. El valor predeterminado es100. -
Número de la página que muestra el conjunto actual del total de objetos que devuelve la respuesta.
El valor mínimo es
1. El valor por defecto es1. -
Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint.
El valor por defecto es
false.Impresión bonita -
Duración del tiempo durante el cual la query encuentra los índices sugeridos entre los namespaces gestionados en el clúster. Este parámetro expresa su valor en milisegundos.
- Si no especificas el parámetro since, el endpoint devuelve datos que cubren la duración antes de la hora actual.
- Si no se especifican ni los parámetros duration ni since, el endpoint retorna datos de las 24 horas anteriores.
-
Espacios de nombres desde los cuales recuperar índices sugeridos. Un namespace consiste en una base de datos y un recurso de colección escrito como
.:<database>.<collection>. Para incluir varios espacios de nombres, pase el parámetro múltiples veces, delimitado con un ampersand (&) entre cada espacio de nombres. Omite este parámetro para devolver resultados para todos los espacios de nombres. -
Número máximo de consultas de ejemplo que se benefician del índice sugerido.
El valor por defecto es
5. -
Número que indica los máximos índices a sugerir.
-
Fecha y hora desde la cual la query recupera los índices sugeridos. Este parámetro expresa su valor en el número de milisegundos transcurridos desde la Unix epoch.
- Si no se especifica el parámetro de duración, el endpoint devuelve datos que cubren desde el valor de desde hasta el momento actual.
- Si no especifica ni los parámetros de duración ni desde, el punto final devuelve datos de las 24 horas anteriores.
El valor mínimo es
1199145600000.
curl \
--request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/processes/{processId}/performanceAdvisor/suggestedIndexes' \
--header "Authorization: Bearer $ACCESS_TOKEN"{
"shapes": [
{
"avgMs": 42,
"count": 42,
"id": "32b6e34b3d91647abb20e7b8",
"inefficiencyScore": 42,
"namespace": "string",
"operations": [
{
"predicates": [
{}
],
"stats": {
"ms": 42,
"nReturned": 42,
"nScanned": 42,
"ts": 42
}
}
]
}
],
"suggestedIndexes": [
{
"avgObjSize": 42.0,
"id": "32b6e34b3d91647abb20e7b8",
"impact": [
"string"
],
"index": [
{
"additionalProperty1": 1,
"additionalProperty2": 1
}
],
"namespace": "string",
"weight": 42.0
}
]
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"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"
}{
"error": 429,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Too Many Requests",
"errorCode": "RATE_LIMITED"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}