你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Get Service Statistics - Get Service Statistics
获取搜索服务的服务级别统计信息。
GET {endpoint}/servicestats?api-version=2023-11-01
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
endpoint
|
path | True |
string |
搜索服务的终结点 URL。 |
api-version
|
query | True |
string |
客户端 API 版本。 |
请求头
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
x-ms-client-request-id |
string uuid |
随请求一起发送以帮助调试的跟踪 ID。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK | ||
Other Status Codes |
错误响应。 |
示例
SearchServiceGetServiceStatistics
Sample Request
GET https://myservice.search.windows.net/servicestats?api-version=2023-11-01
Sample Response
{
"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
}
}
定义
名称 | 说明 |
---|---|
Resource |
表示资源的使用情况和配额。 |
Search |
描述 API 的错误条件。 |
Service |
表示服务级别资源计数器和配额。 |
Service |
表示各种服务级别限制。 |
Service |
来自获取服务统计信息请求的响应。 如果成功,则包含服务级别计数器和限制。 |
ResourceCounter
表示资源的使用情况和配额。
名称 | 类型 | 说明 |
---|---|---|
quota |
integer |
资源量配额。 |
usage |
integer |
资源使用量。 |
SearchError
描述 API 的错误条件。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
服务器定义的一组错误代码中的一个。 |
details |
有关导致此项报告错误的特定错误的详细信息数组。 |
|
message |
string |
错误的用户可读表示形式。 |
ServiceCounters
表示服务级别资源计数器和配额。
名称 | 类型 | 说明 |
---|---|---|
dataSourcesCount |
数据源总数。 |
|
documentCount |
服务中所有索引的文档总数。 |
|
indexersCount |
索引器总数。 |
|
indexesCount |
索引总数。 |
|
skillsetCount |
技能集的总数。 |
|
storageSize |
已用存储的总大小(以字节为单位)。 |
|
synonymMaps |
同义词映射的总数。 |
|
vectorIndexSize |
服务中所有矢量索引的总内存消耗量(以字节为单位)。 |
ServiceLimits
表示各种服务级别限制。
名称 | 类型 | 说明 |
---|---|---|
maxComplexCollectionFieldsPerIndex |
integer |
索引中允许的集合 (Edm.ComplexType 类型的最大字段数) 。 |
maxComplexObjectsInCollectionsPerDocument |
integer |
每个文档允许的复杂集合中的最大对象数。 |
maxFieldNestingDepthPerIndex |
integer |
可以在索引中嵌套子字段的最大深度,包括顶级复杂字段。 例如,a/b/c 的嵌套深度为 3。 |
maxFieldsPerIndex |
integer |
每个索引允许的最大字段数。 |
ServiceStatistics
来自获取服务统计信息请求的响应。 如果成功,则包含服务级别计数器和限制。
名称 | 类型 | 说明 |
---|---|---|
counters |
服务级别资源计数器。 |
|
limits |
服务级别常规限制。 |