Get Service Statistics - Get Service Statistics

Reference

Service:: Search Service

API Version:: 2024-07-01

Gets service level statistics for a search service.

GET {endpoint}/servicestats?api-version=2024-07-01

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string	The endpoint URL of the search service.
api-version	query	True	string	Client Api Version.

Request Header

Name	Required	Type	Description
x-ms-client-request-id		string uuid	The tracking ID sent with the request to help with debugging.

Responses

Name	Type	Description
200 OK	ServiceStatistics
Other Status Codes	ErrorResponse	Error response.

Examples

SearchServiceGetServiceStatistics

Sample request

HTTP

GET https://myservice.search.windows.net/servicestats?api-version=2024-07-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
    },
    "skillsetCount": {
      "usage": 1,
      "quota": 3
    },
    "vectorIndexSize": {
      "usage": 123456,
      "quota": 26214400
    }
  },
  "limits": {
    "maxFieldsPerIndex": 1000,
    "maxFieldNestingDepthPerIndex": 10,
    "maxComplexCollectionFieldsPerIndex": 100,
    "maxComplexObjectsInCollectionsPerDocument": 3000
  }
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ResourceCounter	Represents a resource's usage and quota.
ServiceCounters	Represents service-level resource counters and quotas.
ServiceLimits	Represents various service level limits.
ServiceStatistics	Response from a get service statistics request. If successful, it includes service level counters and limits.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ResourceCounter

Represents a resource's usage and quota.

Name	Type	Description
quota	integer	The resource amount quota.
usage	integer	The resource usage amount.

ServiceCounters

Represents service-level resource counters and quotas.

Name	Type	Description
dataSourcesCount	ResourceCounter	Total number of data sources.
documentCount	ResourceCounter	Total number of documents across all indexes in the service.
indexersCount	ResourceCounter	Total number of indexers.
indexesCount	ResourceCounter	Total number of indexes.
skillsetCount	ResourceCounter	Total number of skillsets.
storageSize	ResourceCounter	Total size of used storage in bytes.
synonymMaps	ResourceCounter	Total number of synonym maps.
vectorIndexSize	ResourceCounter	Total memory consumption of all vector indexes within the service, in bytes.

ServiceLimits

Represents various service level limits.

Name	Type	Description
maxComplexCollectionFieldsPerIndex	integer	The maximum number of fields of type Collection(Edm.ComplexType) allowed in an index.
maxComplexObjectsInCollectionsPerDocument	integer	The maximum number of objects in complex collections allowed per document.
maxFieldNestingDepthPerIndex	integer	The maximum depth which you can nest sub-fields in an index, including the top-level complex field. For example, a/b/c has a nesting depth of 3.
maxFieldsPerIndex	integer	The maximum allowed fields per index.
maxStoragePerIndex	integer	The maximum amount of storage in bytes allowed per index.

ServiceStatistics

Response from a get service statistics request. If successful, it includes service level counters and limits.

Name	Type	Description
counters	ServiceCounters	Service level resource counters.
limits	ServiceLimits	Service level general limits.

Share via