Get Service Statistics - Get Service Statistics

Referencia

Service:: Search Service

API Version:: 2023-11-01

Obtiene estadísticas de nivel de servicio para un servicio de búsqueda.

GET {endpoint}/servicestats?api-version=2023-11-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string	Dirección URL del punto de conexión del servicio de búsqueda.
api-version	query	True	string	Versión de api de cliente.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-request-id		string uuid	Identificador de seguimiento enviado con la solicitud para ayudar con la depuración.

Respuestas

Nombre	Tipo	Description
200 OK	ServiceStatistics
Other Status Codes	SearchError	Respuesta de error.

Ejemplos

SearchServiceGetServiceStatistics

Sample Request

HTTP

GET https://myservice.search.windows.net/servicestats?api-version=2023-11-01

Sample Response

Status code:: 200

{
  "counters": {
    "documentCount": {
      "usage": 7093,
      "quota": 10000
    },
    "indexesCount": {
      "usage": 3,
      "quota": 3
    },
    "indexersCount": {
      "usage": 3,
      "quota": 3
    },
    "dataSourcesCount": {
      "usage": 1,
      "quota": 3
    },
    "storageSize": {
      "usage": 914529,
      "quota": 52428800
    },
    "synonymMaps": {
      "usage": 2,
      "quota": 3
    },
    "vectorIndexSize": {
      "usage": 123456,
      "quota": 26214400
    }
  },
  "limits": {
    "maxFieldsPerIndex": 1000,
    "maxFieldNestingDepthPerIndex": 10,
    "maxComplexCollectionFieldsPerIndex": 100,
    "maxComplexObjectsInCollectionsPerDocument": 3000
  }
}

Definiciones

Nombre	Description
ResourceCounter	Representa el uso y la cuota de un recurso.
SearchError	Describe una condición de error para la API.
ServiceCounters	Representa los contadores y cuotas de recursos de nivel de servicio.
ServiceLimits	Representa varios límites de nivel de servicio.
ServiceStatistics	Respuesta de una solicitud de obtención de estadísticas de servicio. Si se ejecuta correctamente, incluye contadores y límites de nivel de servicio.

ResourceCounter

Representa el uso y la cuota de un recurso.

Nombre	Tipo	Description
quota	integer	Cuota de cantidad de recursos.
usage	integer	Cantidad de uso de recursos.

SearchError

Describe una condición de error para la API.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
details	SearchError[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
message	string	Representación legible del error.

ServiceCounters

Representa los contadores y cuotas de recursos de nivel de servicio.

Nombre	Tipo	Description
dataSourcesCount	ResourceCounter	Número total de orígenes de datos.
documentCount	ResourceCounter	Número total de documentos en todos los índices del servicio.
indexersCount	ResourceCounter	Número total de indizadores.
indexesCount	ResourceCounter	Número total de índices.
skillsetCount	ResourceCounter	Número total de conjuntos de aptitudes.
storageSize	ResourceCounter	Tamaño total del almacenamiento usado en bytes.
synonymMaps	ResourceCounter	Número total de asignaciones de sinónimos.
vectorIndexSize	ResourceCounter	Consumo total de memoria de todos los índices vectoriales dentro del servicio, en bytes.

ServiceLimits

Representa varios límites de nivel de servicio.

Nombre	Tipo	Description
maxComplexCollectionFieldsPerIndex	integer	Número máximo de campos de tipo Collection(Edm.ComplexType) permitidos en un índice.
maxComplexObjectsInCollectionsPerDocument	integer	Número máximo de objetos en colecciones complejas permitidas por documento.
maxFieldNestingDepthPerIndex	integer	Profundidad máxima que puede anidar subcampos en un índice, incluido el campo complejo de nivel superior. Por ejemplo, a/b/c tiene una profundidad de anidamiento de 3.
maxFieldsPerIndex	integer	Los campos máximos permitidos por índice.

ServiceStatistics

Respuesta de una solicitud de obtención de estadísticas de servicio. Si se ejecuta correctamente, incluye contadores y límites de nivel de servicio.

Nombre	Tipo	Description
counters	ServiceCounters	Contadores de recursos de nivel de servicio.
limits	ServiceLimits	Límites generales de nivel de servicio.