GetDocument 查询文档-表格存储 Tablestore(Tablestore)-阿里云帮助中心

使用 GetDocument 接口查询指定文档的详细信息。

前提条件

已创建 AgentStorage 实例且状态为 normal，并获取实例访问地址（endpoint）和实例名。
已创建 API Key。
待查询的知识库与文档已存在。

请求参数

参数	类型	说明
`knowledgeBaseName`	string	知识库名称（必填）
`subspace`	string	子空间名称。开启 subspace 时必填
`docId`	string	文档 ID。与 `ossKey` 二选一
`ossKey`	string	OSS 文件路径。与 `docId` 二选一

请求示例

使用 API Key 认证时，通过 x-ots-instancename 和 x-ots-apikey 请求头传入实例名和 API Key。

curl -X POST https://<endpoint>/GetDocument \
  -H "x-ots-instancename: <instance-name>" \
  -H "x-ots-apikey: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "knowledgeBaseName": "product_docs_kb",
  "subspace": "default",
  "ossKey": "oss://example-bucket/docs/manual.pdf"
}'

响应

字段	类型	说明
`docId`	string	文档 ID
`ossKey`	string	OSS 路径
`subspace`	string	子空间
`chunkNum`	int	切片数量
`status`	string	文档状态：pending/indexing/completed/failed/deleting
`createdAt`	int	创建时间戳
`updatedAt`	int	更新时间戳
`eTag`	string	文档 eTag
`failedDetails`	string	失败原因（仅 failed 时）
`metadata`	object	文档元数据

{
    "code": "SUCCESS",
    "data": [
        {
            "docId": "fc6ed97f-28ad-4dc0-9b73-bf4a7d67ab65",
            "ossKey": "oss://example-bucket/docs/manual.pdf",
            "subspace": "default",
            "chunkNum": 1,
            "status": "completed",
            "createdAt": 1787636583092,
            "eTag": "6227CEC56ABFAF47135E4C033FF24C98",
            "updatedAt": 1787636583092, "metadata": {"author": "张三", "date": "2026-01-22 10:00:59", "score": 80}
        }
    ],
    "message": "succeed"
}