/ /

Gerente de Operaciones

Obtener índices sugeridos

Recupera los índices sugeridos según lo determinado por el Asesor de desempeño.

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource

GET /groups/{PROJECT-ID}/hosts/{HOST-ID}/performanceAdvisor/suggestedIndexes

Parámetros de la ruta de solicitud

Parameter	Tipo	Descripción
PROJECT-ID	string	(Obligatorio) Identificador único del proyecto propietario de este proceso MongoDB.
ID DE HOST	string	(Obligatorio) Identificador único del host para el proceso MongoDB.

Parámetros de consulta de solicitud

Todos los parámetros son opcionales.

bonita

booleano

Indica si el cuerpo de la respuesta debe estar en un impresión bonita formato.

false

envolvente

booleano

Indica si se debe envolver o no la respuesta en un sobre.

false

desde

long

Punto en el tiempo desde el cual recuperar los índices sugeridos, indicado en milisegundos desde la época.

las últimas 24 horas

duración

long

Duración en milisegundos durante la cual se deben encontrar los índices sugeridos entre los namespaces gestionados en el clúster.

hasta el momento actual

espacios de nombres

string

Espacios de nombres de los que se pueden recuperar los índices sugeridos. Un espacio de nombres consta de la base de datos y el recurso de colección, separados por un ., como <database>.<collection>.

Para especificar múltiples espacios de nombres, pase el parámetro varias veces usando un símbolo & (&) como delimitador, una vez para cada espacio de nombres.

Por ejemplo:

?namespaces=data.stocks&namespaces=data.zips&pretty=true

todos

nIndexes

long

Número máximo de índices a sugerir.

ilimitado

nExamples

long

Número máximo de consultas de ejemplos a proporcionar que se mejorarán mediante un índice sugerido.

Parámetros del cuerpo de la solicitud

Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.

Respuesta

Nombre	Tipo	Descripción
`shapes`	conjunto de documentos	Documentos con información sobre las formas de consulta que atienden los índices sugeridos.
`shapes[n].avgMs`	Número	Duración promedio en milisegundos para las consultas examinadas que coinciden con esta forma.
`shapes[n].count`	Número	Número de consultas examinadas que coinciden con esta forma.
`shapes[n].id`	ObjectId	Identificador único de esta forma. Existe solo mientras dura la solicitud de API.
`shapes[n].inefficiencyScore`	Número	Número promedio de documentos leídos por cada documento devuelto por la consulta. Para más información, consulte "Comprender la puntuación de ineficiencia de las consultas".
`shapes[n].namespace`	string	Espacio de nombres buscado por las consultas en esta forma.
`shapes[n].operations`	conjunto de documentos	Documentos con información específica y líneas de registro para consultas individuales.
`shapes[n].operations[n].predicates`	conjunto de documentos	Documentos que contienen los criterios de búsqueda utilizados en la consulta. Los valores de los pares clave-valor se eliminarán en estos predicados, a menos que el usuario tenga permisos de acceso a datos del proyecto de solo lectura o superiores.
`shapes[n].operations[n].raw`	string	Línea de registro sin procesar producida por la consulta.
`shapes[n].operations[n].stats`	Documento	Estadísticas de consultas.
`shapes[n].operations[n].stats.ms`	Número	Duración en milisegundos de la consulta.
`shapes[n].operations[n].stats.nReturned`	Número	Número de resultados devueltos por la consulta.
`shapes[n].stats.avgObjSize`	Número	Tamaño promedio de los objetos.
`shapes[n].stats.nScanned`	Número	Número de documentos leídos por la consulta.
`shapes[n].stats.ts`	Número	Marca de tiempo de la consulta, en segundos desde la época.
`suggestedIndexes`	conjunto de documentos	Documentos con información sobre los índices sugeridos por el Asesor de Desempeño.
`suggestedIndexes[n].id`	ObjectId	Identificador único para este índice sugerido.
`suggestedIndexes[n].impact`	arreglo de objectIds	Lista de identificadores únicos que corresponden a las formas de consulta en esta respuesta que pertenecen a este índice sugerido. Este campo no corresponde a Impact en la interfaz de usuario de Performance Advisor.
`suggestedIndexes[n].index`	conjunto de documentos	Cada elemento de la matriz es un documento que especifica una clave en el índice y su orden de clasificación, ascendente o descendente. Un valor de 1 indica un orden de clasificación ascendente. Un valor de -1 indica un orden de clasificación descendente. Las claves en índices con múltiples claves aparecen en el mismo orden en que aparecen en el índice.
`suggestedIndexes[n].index.<fieldname>`	string	Campo específico a indexar.
`suggestedIndexes[n].namespace`	string	Espacio de nombres del índice sugerido.
`suggestedIndexes[n].weight`	Número	Mejora estimada del rendimiento que proporcionaría el índice sugerido. Corresponde al impacto en la interfaz de usuario del Asesor de Rendimiento.

Ejemplo de solicitud

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --header 'Accept: application/json' \
 --include \
 --request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}/performanceAdvisor/suggestedIndexes?pretty=true'

Ejemplo de respuesta

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}

Cuerpo de respuesta

{
  "shapes" : [ {
    "avgMs" : 42,
    "count" : 2,
    "id" : "5b74689a80eef53f3388897e",
    "inefficiencyScore" : 50000,
    "namespace" : "test.users",
    "operations" : [ {
      "predicates" : [{ "find" : { "emails" : "la@sa.kp" } }],
      "raw" : "2018-08-15T17:14:11.115+0000 I COMMAND  [conn4576] command test.users appName: \"MongoDB Shell\" command: find { find: \"users\", filter: { emails: \"la@sa.kp\" }, lsid: { id: UUID(\"1a4e71d3-9b67-4e9c-b078-9fdf3fae9091\") }, $clusterTime: { clusterTime: Timestamp(1534353241, 1), signature: { hash: BinData(0, AB91938B7CF7BC87994A2909A98D87F29101EFA0), keyId: 6589681559618453505 } }, $db: \"test\" } planSummary: COLLSCAN keysExamined:0 docsExamined:50000 cursorExhausted:1 numYields:391 nreturned:1 reslen:339 locks:{ Global: { acquireCount: { r: 784 } }, Database: { acquireCount: { r: 392 } }, Collection: { acquireCount: { r: 392 } } } protocol:op_msg 34ms",
      "stats" : {
        "ms" : 34,
        "nReturned" : 1,
        "nScanned" : 50000,
        "ts" : 1534353251147
      }
    }, {
      "predicates" : [{ "find" : { "emails" : "tocde@fijoow.to" } }],
      "raw" : "2018-08-15T17:14:18.665+0000 I COMMAND  [conn4576] command test.users appName: \"MongoDB Shell\" command: find { find: \"users\", filter: { emails: \"tocde@fijoow.to\" }, lsid: { id: UUID(\"1a4e71d3-9b67-4e9c-b078-9fdf3fae9091\") }, $clusterTime: { clusterTime: Timestamp(1534353241, 1), signature: { hash: BinData(0, AB91938B7CF7BC87994A2909A98D87F29101EFA0), keyId: 6589681559618453505 } }, $db: \"test\" } planSummary: COLLSCAN keysExamined:0 docsExamined:50000 cursorExhausted:1 numYields:390 nreturned:1 reslen:342 locks:{ Global: { acquireCount: { r: 782 } }, Database: { acquireCount: { r: 391 } }, Collection: { acquireCount: { r: 391 } } } protocol:op_msg 36ms",
      "stats" : {
        "ms" : 36,
        "nReturned" : 1,
        "nScanned" : 50000,
        "ts" : 1534353258697
      }
    } ]
  } ],
  "suggestedIndexes" : [ {
    "id" : "5b74689a80eef53f3388897f",
    "impact" : [ "5b74689a80eef53f3388897e" ],
    "index" : [ {
      "emails" : 1
    } ],
    "namespace" : "test.users",
    "weight" : 37.220480901815623
  }, {
    "id" : "5b74689a80eef53f33888980",
    "impact" : [ "5b74689a80eef53f3388897d" ],
    "index" : [ {
      "email" : 1
    } ],
    "namespace" : "test.inventory",
    "weight" : 19.037578309966488
  } ]
}

Volver

Obtener registros de consultas lentas

Configuración de integración