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

Knowledge Sources - Get Status

服务:: Search Service

API 版本:: 2026-08-01-preview

检索知识源的状态。

GET {endpoint}/knowledgesources('{sourceName}')/status?api-version=2026-08-01-preview

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string (uri)	搜索服务的终结点 URL。
sourceName	path	True	string	知识源的名称。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

请求头

名称	必需	类型	说明
Accept		Accept	接受（Accept）首部。
x-ms-client-request-id		string (uuid)	请求的不透明、全局唯一的客户端生成的字符串标识符。

响应

名称	类型	说明
200 OK	KnowledgeSourceStatus	请求已成功。
Other Status Codes	ErrorResponse	未预期的错误响应。

安全性

api-key

类型: apiKey
在: header

OAuth2Auth

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

作用域

名称	说明
https://search.azure.com/.default

示例

SearchServiceGetKnowledgeSourceStatus

示例请求

HTTP

GET https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')/status?api-version=2026-08-01-preview

示例响应

状态代码:: 200

{
  "kind": "azureBlob",
  "synchronizationStatus": "active",
  "synchronizationInterval": "1d",
  "currentSynchronizationState": {
    "startTime": "2024-11-26T03:37:18.853Z",
    "itemsUpdatesProcessed": 10,
    "itemsUpdatesFailed": 2,
    "itemsSkipped": 1,
    "errors": []
  },
  "lastSynchronizationState": {
    "startTime": "2024-11-25T03:37:18.853Z",
    "endTime": "2024-11-25T03:38:19.012Z",
    "itemsUpdatesProcessed": 8,
    "itemsUpdatesFailed": 1,
    "itemsSkipped": 0
  },
  "statistics": {
    "totalSynchronization": 5,
    "averageSynchronizationDuration": "PT30M",
    "averageItemsProcessedPerSynchronization": 100
  }
}

定义

名称	说明
Accept	接受（Accept）首部。
CompletedSynchronizationState	表示上次同步的完成状态。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详情
ErrorResponse	所有 Azure 资源管理器 API 的常见错误响应，以返回失败操作的错误详细信息。（这也遵循 OData 错误响应格式）。
KnowledgeSourceKind	知识来源的那种。
KnowledgeSourceStatistics	有关知识源同步历史的统计信息。
KnowledgeSourceStatus	表示知识源的状态和同步历史记录。
KnowledgeSourceSynchronizationError	表示在知识源同步运行过程中遇到的文档级索引错误。
KnowledgeSourceSynchronizationStatus	知识源的当前同步状态。
SynchronizationState	表示跨多个索引器运行的正在进行的同步的当前状态。

Accept

枚举

接受（Accept）首部。

值	说明
application/json;odata.metadata=minimal

CompletedSynchronizationState

对象

表示上次同步的完成状态。

名称	类型	说明
endTime	string (date-time)	上次完成的同步的结束时间。
itemsSkipped	integer (int32)	上次同步中跳过的项数。
itemsUpdatesFailed	integer (int32)	在上次同步中失败的项更新数。
itemsUpdatesProcessed	integer (int32)	在上次同步中成功处理的项更新数。
startTime	string (date-time)	上次完成的同步的开始时间。

ErrorAdditionalInfo

对象

资源管理错误附加信息。

名称	类型	说明
info		附加信息。
type	string	其他信息类型。

ErrorDetail

对象

错误详情

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误的附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详情。
message	string	错误消息。
target	string	错误的目标。

ErrorResponse

对象

所有 Azure 资源管理器 API 的常见错误响应，以返回失败操作的错误详细信息。（这也遵循 OData 错误响应格式）。

名称	类型	说明
error	ErrorDetail	错误对象。

KnowledgeSourceKind

枚举

知识来源的那种。

值	说明
searchIndex	从搜索索引中读取数据的知识源。
azureBlob	用于读取数据并将其从 Azure Blob 存储引入搜索索引的知识源。
indexedSharePoint	一个读取索引 SharePoint 数据的知识源。
indexedOneLake	一个读取索引 OneLake 数据的知识源。
indexedSql	一个知识源，可以从Azure SQL 数据库或SQL 托管实例获取数据到搜索索引。
web	一个从网络读取数据的知识源。
remoteSharePoint	一个读取远程SharePoint数据的知识源。
workIQ	一个读取工作智商数据的知识源
file	一个支持直接文件上传和索引的知识源。
mcpServer	一个由MCP（模型上下文协议）服务器支持的知识源。
fabricDataAgent	一个从Fabric数据代理获取数据的知识源。
fabricOntology	一个从Microsoft Fabric本体中提取数据的知识源。

KnowledgeSourceStatistics

对象

有关知识源同步历史的统计信息。

名称	类型	说明
averageItemsProcessedPerSynchronization	integer (int32)	每次同步处理的平均物品。
averageSynchronizationDuration	string	HH：MM：SS格式的平均同步时长。
totalSynchronization	integer (int32)	同步次数总数。

KnowledgeSourceStatus

对象

表示知识源的状态和同步历史记录。

名称	类型	说明
currentSynchronizationState	SynchronizationState	跨多个索引器运行的当前同步状态。
kind	KnowledgeSourceKind	直接从状态响应中识别知识源类型。
lastSynchronizationState	CompletedSynchronizationState	上次完成的同步的详细信息。第一次同步时为 Null。
statistics	KnowledgeSourceStatistics	有关知识源同步历史记录的统计信息。第一次同步时为 Null。
synchronizationInterval	string	同步间隔（例如，“1d”表示每日）。如果未配置计划，则为 Null。
synchronizationStatus	KnowledgeSourceSynchronizationStatus	当前同步状态。

KnowledgeSourceSynchronizationError

对象

表示在知识源同步运行过程中遇到的文档级索引错误。

名称	类型	说明
details	string	关于失败的额外背景信息。
docId	string	同步运行中失败文档或项目的唯一标识符。
documentationLink	string	相关故障排除文档链接。
errorMessage	string	人类可读、客户可见的错误信息。
name	string	报告错误的摄取或处理组件名称。
statusCode	integer (int32)	类似HTTP的状态代码表示故障类别（例如400）。

KnowledgeSourceSynchronizationStatus

枚举

知识源的当前同步状态。

值	说明
creating	正在预配知识源。
active	知识源处于活动状态，并且正在进行同步运行。
deleting	知识源正在删除，同步已暂停。

SynchronizationState

对象

表示跨多个索引器运行的正在进行的同步的当前状态。

名称	类型	说明
errors	KnowledgeSourceSynchronizationError[]	当前同步运行中遇到的文档级索引错误集合。仅在出现错误时返回。
itemsSkipped	integer (int32)	当前同步中跳过的项数。
itemsUpdatesFailed	integer (int32)	当前同步中失败的项更新数。
itemsUpdatesProcessed	integer (int32)	当前同步中成功处理的项更新数。
startTime	string (date-time)	当前同步的开始时间。