Get Service Statistics - Get Service Statistics

Service:

Search Service

API Version:

2023-11-01

取得搜尋服務的服務等級統計數據。

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

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string	搜尋服務的端點 URL。
api-version	query	True	string	用戶端 API 版本。

要求標頭

名稱	必要	類型	Description
x-ms-client-request-id		string uuid	使用要求傳送的追蹤標識碼，以協助偵錯。

回應

名稱	類型	Description
200 OK	ServiceStatistics
Other Status Codes	SearchError	錯誤回應。

範例

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
  }
}

定義

名稱	Description
ResourceCounter	表示資源的使用量和配額。
SearchError	描述 API 的錯誤狀況。
ServiceCounters	表示服務層級資源計數器和配額。
ServiceLimits	表示各種服務等級限制。
ServiceStatistics	從取得服務統計數據要求回應。 如果成功，則會包含服務等級計數器和限制。

ResourceCounter

表示資源的使用量和配額。

名稱	類型	Description
quota	integer	資源數量配額。
usage	integer	資源使用量金額。

SearchError

描述 API 的錯誤狀況。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
details	SearchError[]	導致此錯誤之特定錯誤的詳細數據陣列。
message	string	人類可讀取的錯誤表示法。

ServiceCounters

表示服務層級資源計數器和配額。

名稱	類型	Description
dataSourcesCount	ResourceCounter	數據源總數。
documentCount	ResourceCounter	服務中所有索引的文件總數。
indexersCount	ResourceCounter	索引器總數。
indexesCount	ResourceCounter	索引總數。
skillsetCount	ResourceCounter	技能集總數。
storageSize	ResourceCounter	已使用記憶體的大小總計，以位元組為單位。
synonymMaps	ResourceCounter	同義字對應總數。
vectorIndexSize	ResourceCounter	服務內所有向量索引的記憶體耗用量總計，以位元組為單位。

ServiceLimits

表示各種服務等級限制。

名稱	類型	Description
maxComplexCollectionFieldsPerIndex	integer	集合類型 (Edm.ComplexType) 在索引中允許的欄位數目上限。
maxComplexObjectsInCollectionsPerDocument	integer	每個文件允許的複雜集合中物件數目上限。
maxFieldNestingDepthPerIndex	integer	您可以在索引中巢狀子字段的最大深度，包括最上層的複雜欄位。 例如，a/b/c 的巢狀深度為 3。
maxFieldsPerIndex	integer	每個索引允許的欄位上限。

ServiceStatistics

從取得服務統計數據要求回應。 如果成功，則會包含服務等級計數器和限制。

名稱	類型	Description
counters	ServiceCounters	服務等級資源計數器。
limits	ServiceLimits	服務等級一般限制。