通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

获取索引统计信息（预览版 REST API）

  • 项目

适用于：2023-07-01-Preview。 此版本不再受支持。 将立即升级到较新版本。

重要

2023-07-01-Preview 将 vectorIndexSize 范围添加到索引。

获取索引统计信息 操作将返回当前索引的文档计数，以及索引全部使用的总存储量，以及仅其矢量数据消耗的存储量。 搜索服务对 获取服务统计信息报告的矢量存储量有总体限制。 “vectorIndexSize”指标指示当前搜索索引中的向量字段使用多少向量存储。

注意

每隔几分钟收集一次有关文档计数和存储大小的统计信息，而不是实时收集一次。 因此，此 API 返回的统计信息可能不会反映最近索引操作导致的更改。

GET https://[service name].search.windows.net/indexes/[index name]/stats?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 密钥字段。 有关详细信息，请参阅 使用密钥身份验证 连接到 Azure AI 搜索。

请求正文

没有。

响应

状态代码：为成功的响应返回“200 正常”。 响应正文采用以下格式：

{  
  "documentCount": number,  
  "storageSize": number (size of the index in bytes), 
  "vectorIndexSize": number (size of the index in bytes) 
}

如果索引中没有矢量字段，则“vectorIndexSize”为零。

另请参阅