你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
获取服务统计信息（预览版 REST API）
适用于：2023-07-01-Preview。 此版本不再受支持。 将立即升级到较新版本。
重要
2023-07-01-Preview 将 vectorIndexSize 范围添加到搜索服务。
2021-04-30-Preview 添加了 aliasesCount。
服务统计信息 操作返回服务中的对象数和类型、给定服务层级给定的每个对象类型允许的最大数目、实际存储量和最大存储量以及其他因层而异的限制。 此请求从服务拉取信息，以便无需查找或计算 服务限制。
每隔几分钟收集一次有关文档计数和存储大小的统计信息，而不是实时收集一次。 因此，此 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 版本。 |
请求标头
下表描述了必需的和可选的请求标头。
| 领域 | 描述 |
|---|---|
| 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 unlimited 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
},
"aliasesCount": {
"usage": number,
"quota": number
},
"vectorIndexSize": {
"usage": number (bytes),
"quota": number (bytes)
}
},
"limits": {
"maxFieldsPerIndex": number,
"maxIndexerRunTime": string,
"maxFileExtractionSize": number,
"maxFileContentCharactersToExtract": number,
"maxFieldNestingDepthPerIndex": number,
"maxComplexCollectionFieldsPerIndex": number,
"maxComplexObjectsInCollectionsPerDocument": number
}
}
| 统计 | 类型 | 描述 |
|---|---|---|
| documentCount | 计数 | 来自所有索引的所有文档的聚合。 早期版本的 Azure AI 搜索强制实施文档计数限制，但该限制不再存在。 配额始终为 null，指示服务可以具有无限制的文档计数。 |
| indexesCount | 计数 | 搜索服务上的索引数。 根据配额报告，最大索引因层而异。 |
| indexersCount | 计数 | 搜索服务上的索引器数。 按配额报告的最大索引器因层而异。 |
| dataSourcesCount | 计数 | 搜索服务上的数据源数。 根据配额报告，最大数据源因层而异。 最大数据源数与最大索引器相同。 |
| aliasesCount | 计数 | 搜索服务上的索引别名数。 根据配额报告，最大值因层而异。 |
| synonymMaps | 计数 | 搜索服务上的同义词映射数。 根据配额报告，最大值因层而异。 |
| storageSize | 字节 | 使用情况是服务上所有对象使用的存储量。 配额是基于为服务配置的分区大小和数量提供的最大存储。 配额增加和减少，以响应搜索服务中预配的分区数。 分区大小因层而异。 |
| vectorIndexSize | 字节 | 矢量索引是一个内部结构，每个向量字段的向量索引为一个矢量索引，如搜索索引中定义。 在整个服务中报告总使用量，以便可以监视相对于搜索服务的矢量索引限制的矢量空间消耗。 配额因搜索服务年龄、分区数以及按层确定的分区大小而异。 |
有关所有限制的详细信息，请参阅 服务限制。
例子
此 API 是数据平面。 若要获取有关服务（例如其层或位置）的详细信息，请参阅 管理 REST API。
{
"@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
},
"aliasesCount": {
"usage": 7,
"quota": 30
},
"vectorIndexSize": {
"usage": 1342476,
"quota": 1073741824
},
"limits": {
"maxFieldsPerIndex": 1000,
"maxIndexerRunTime": "P1D",
"maxFileExtractionSize": 16777216,
"maxFileContentCharactersToExtract": 65536,
"maxFieldNestingDepthPerIndex": 10,
"maxComplexCollectionFieldsPerIndex": 40,
"maxComplexObjectsInCollectionsPerDocument": 3000
}
}