接口描述
获取文档元数据(doc-info)接口用于获取文档的元数据信息,包括文档格式、总页数、文件大小、是否加密、创建时间、修改时间。
授权说明
服务开通
注意:
数据万象绑定后,如果您手动对存储桶进行数据万象的解绑操作,将无法继续使用该功能。
使用限制
文档格式限制:pdf。
文档大小限制:不超过1GB。
接口请求默认并发数:100。
费用说明
请求
请求示例
GET /document.pdf?ci-process=doc-info HTTP/1.1Host: examplebucket-1250000000.cos.ap-beijing.myqcloud.comDate: Tue, 01 Sep 2026 07:00:00 GMTAuthorization: q-sign-algorithm=sha1&q-ak=***&q-key-time=***;***&q-header-list=host&q-url-param-list=ci-process&q-signature=***Content-Length: 0
说明:
请求参数
参数 | 描述 | 类型 | 是否必选 |
ObjectKey | 对象文件名,例如 folder/document.pdf | String | 是 |
ci-process | 数据万象处理能力,获取文档元数据固定为 doc-info | String | 是 |
srcType | 源文件的后缀类型,用于指定源文件格式,当前仅支持 pdf。当 COS 对象没有后缀名时,可以通过该参数指定文件类型 | String | 否 |
password | 加密 PDF 的打开密码。加密文档必须携带密码才能解析,未携带密码或密码错误则返回错误;未加密文档传入不生效 | String | 否(加密文档必传) |
响应
响应示例
<Response><DocMetadata><Format>pdf</Format><TotalPageCount>12</TotalPageCount><Size>1048576</Size><Encrypted>false</Encrypted><CreationDate>2026-08-15T03:20:00Z</CreationDate><ModifyDate>2026-08-20T09:41:00Z</ModifyDate></DocMetadata></Response>
响应参数
具体的响应数据内容如下:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Response | 无 | 保存结果的容器 | Container |
Container 节点 Response 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
DocMetadata | Response | 文档元数据 | Container |
Container 节点 DocMetadata 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Format | DocMetadata | 文档格式,当前仅支持 pdf | String |
TotalPageCount | DocMetadata | 文档总页数,返回实际页数 | String |
Size | DocMetadata | 文件大小,单位为 Byte | String |
Encrypted | DocMetadata | 文档是否加密。true 表示已加密,false 表示未加密 | String |
CreationDate | DocMetadata | 文档创建时间,取文档内部记录的创建时间属性,ISO 8601 格式,例如2026-08-15T03:20:00Z | String |
ModifyDate | DocMetadata | 文档修改时间,取文档内部记录的最后修改时间属性,ISO 8601 格式,例如2026-08-20T09:41:00Z | String |
注意:
当某字段未获取到有效值时,该字段返回为空。例如文档内部未记录创建时间时,CreationDate 返回为空。
对于加密文档(Encrypted 为 true),正常情况下仍会返回总页数;若加密导致文件内容完全无法读取,则返回错误。
使用案例
对存储桶 examplebucket-1250000000 中 ObjectKey 为 document.pdf 的文件获取元数据信息,最终 URL 如下:
https://examplebucket-1250000000.cos.ap-beijing.myqcloud.com/document.pdf?ci-process=doc-info
请求成功后,返回该文档的格式、总页数、文件大小、是否加密及创建、修改时间等信息,示例如下:
<Response><DocMetadata><Format>pdf</Format><TotalPageCount>12</TotalPageCount><Size>1048576</Size><Encrypted>false</Encrypted><CreationDate>2026-08-15T03:20:00Z</CreationDate><ModifyDate>2026-08-20T09:41:00Z</ModifyDate></DocMetadata></Response>
错误码
错误码 | 错误信息 | 说明 |
-3405 | PDF file is password protected, please carry the correct password | PDF 打开密码加密:未带 password 或密码错误 |
-3406 | Invalid or corrupted PDF file, we cannot parse it | PDF 文件损坏 |
-3407 | The size of file exceeds the limit. Please select files less than 1024M | PDF 大小超过1GB的限制 |