获取文档索引或资源变更

接口说明

使用上传或资源变更返回的 operationId，查询处理状态、逐步完成的文档数量、最终结果和错误信息。

接口信息

字段	值
方法	GET
路径	/openapi/v2/knowledge-bases/{knowledgeBaseId}/operations/{operationId}
Operation ID	getResourceOperation
鉴权	Bearer OpenAPI key

入参

名称	位置	必填	类型	示例	说明
knowledgeBaseId	path	是	string	knowledge-base-11111111-1111-4111-8111-111111111111	知识库 API 返回的知识库标识。
operationId	path	是	string	source-move-11111111-1111-4111-8111-111111111111	文件或目录移动、替换和删除请求返回的变更标识。

请求体

这个接口没有请求体。

请求示例

curl -X GET "https://openapi.example.com/openapi/v2/knowledge-bases/knowledge-base-11111111-1111-4111-8111-111111111111/operations/source-move-11111111-1111-4111-8111-111111111111" \
  -H "Authorization: Bearer <openapi-key>"

成功响应

200

返回指定上传索引或资源变更的状态和结果。

字段	必填	类型	说明
operation	是	object	资源变更记录。

成功响应示例

{
  "operation": {
    "operationId": "source-move-11111111-1111-4111-8111-111111111111",
    "knowledgeBaseId": "knowledge-base-11111111-1111-4111-8111-111111111111",
    "kind": "source_file_move",
    "state": "processing",
    "expectedResourceRevision": 1,
    "targetKind": "source_file",
    "targetId": "source-file-11111111-1111-4111-8111-111111111111",
    "candidateRelativePath": "handbook/setup/install.md",
    "result": null,
    "errorCode": null,
    "retryGuidance": "Check this change again after a short delay.",
    "actions": {
      "self": "/openapi/v2/knowledge-bases/knowledge-base-11111111-1111-4111-8111-111111111111/operations/source-move-11111111-1111-4111-8111-111111111111"
    },
    "createdAt": "2026-06-17T00:00:00.000Z",
    "updatedAt": "2026-06-17T00:00:00.000Z",
    "completedAt": null
  }
}

错误码

下表列出这个接口已声明的全部错误响应。

HTTP 状态	错误码	说明
401	UNAUTHORIZED	Bearer API key 缺失、格式错误、未知、已撤销或已删除。
404	NOT_FOUND	请求的资源不存在。
429	RATE_LIMITED	请求超过当前配置的速率限制。
500	INTERNAL_ERROR	API 遇到内部错误。
503	DATABASE_REPOSITORY_UNAVAILABLE	当前接口所需的数据暂时不可用。