你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Azure AI 搜索中的服务统计信息
服务统计信息操作返回服务中对象的数量和类型、给定服务层的每个对象类型允许的最大数量、实际和最大存储量，以及因层而异的其他限制。 此请求从服务中拉取信息，以便你不必查找或计算 服务限制。
每隔几分钟收集关于文档计数和存储大小的统计信息，而非实时收集。 因此，此 API 返回的统计信息可能不反映最近的索引操作导致的更改。
GET https://[service name].search.windows.net/servicestats?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
URI 参数
| 参数 | 说明 |
|---|---|
| 服务名称 | 必需。 将此设置为搜索服务的唯一用户定义名称。 请求 URI 指定应为其返回统计信息的索引的名称。 |
| api-version | 必需。 当前稳定版本为 api-version=2020-06-30。 有关更多 版本，请参阅 API 版本。 |
请求标头
下表介绍必需和可选的请求标头。
| 字段 | 说明 |
|---|---|
| Content-Type | 必需。 将其设置为 application/json |
| api-key | 如果使用 Azure 角色 并且请求中提供了持有者令牌，则为可选，否则需要密钥。 api-key 是系统生成的唯一字符串，用于对搜索服务的请求进行身份验证。 获取对象定义的请求必须包括设置为管理密钥 (而不是查询密钥) 的 api-key 字段。 有关详细信息 ，请参阅使用密钥身份验证连接到 Azure AI 搜索 。 |
请求正文
无。
响应
状态代码：成功响应返回“200 正常”。 响应正文格式如下：
{
"counters": {
"documentCount": {
"usage": number,
"quota": number | null (if the service has unlimitied document counts, the quota will be null)
},
"indexesCount": {
"usage": number,
"quota": number
},
"indexersCount": {
"usage": number,
"quota": number
},
"dataSourcesCount": {
"usage": number,
"quota": number
},
"storageSize": {
"usage": number (bytes),
"quota": number (bytes)
},
"synonymMaps": {
"usage": number,
"quota": number
}
},
"limits": {
"maxFieldsPerIndex": number,
"maxIndexerRunTime": string,
"maxFileExtractionSize": number,
"maxFileContentCharactersToExtract": number,
"maxFieldNestingDepthPerIndex": number,
"maxComplexCollectionFieldsPerIndex": number,
"maxComplexObjectsInCollectionsPerDocument": number
}
}
示例
{
"@odata.context": "https://my-search-service.search.windows.net/$metadata#Microsoft.Azure.Search.V2019_05_06.ServiceStatistics",
"counters": {
"documentCount": {
"usage": 5072,
"quota": null
},
"indexesCount": {
"usage": 10,
"quota": 15
},
"indexersCount": {
"usage": 8,
"quota": 15
},
"dataSourcesCount": {
"usage": 9,
"quota": 15
},
"storageSize": {
"usage": 22265221,
"quota": 2147483648
},
"synonymMaps": {
"usage": 0,
"quota": 3
}
},
"limits": {
"maxFieldsPerIndex": 1000,
"maxIndexerRunTime": "P1D",
"maxFileExtractionSize": 16777216,
"maxFileContentCharactersToExtract": 65536,
"maxFieldNestingDepthPerIndex": 10,
"maxComplexCollectionFieldsPerIndex": 40,
"maxComplexObjectsInCollectionsPerDocument": 3000
}
}