全部产品
云市场

GetDocIndex

更新时间:2018-11-29 11:04:50

GetDocIndex

获取文档索引信息。(当前只支持上海 Region)

请求参数

名称 类型 是否必填 描述
Action String GetDocIndex
Project String 项目名
Set String 集合名,存储索引文档的容器
UniqueId String 文档唯一 ID,参考 CreateOfficeIndexTask 时使用的 SrcUri 或者 UniqueId

返回参数

名称 类型 描述
RequestId String 用户发送的每次接口调用请求,无论成功与否,系统都会返回一个唯一识别码 RequestId 给用户
IndexCreatedTime String 索引创建时间
IndexModifiedTime String 索引更新时间
UniqueId String 文档唯一 ID
SrcUri String 提交索引时的 SrcUri
Name String 文档名称
ContentType String 文档类型
LastModified String 文档修改时间
Size String 文档大小
PageNum String 文档页数
CustomKey1 String 支持前缀匹配的 Key1,可以存储文件系统路径,用来搜索指定范围的数据
CustomKey2 String 支持前缀匹配的 Key2,可以存储文件系统路径,用来搜索指定范围的数据
CustomKey3 String 支持精准匹配的 Key3
CustomKey4 String 支持精准匹配的 Key4
CustomKey5 String 支持全文检索的 Key5,可以存储标签等
CustomKey6 String 支持全文检索的 Key6,可以存储标签等

示例

请求示例

  1. POST https://imm.cn-shanghai.aliyuncs.com
  2. ?Action=GetDocIndex
  3. &Project=test
  4. &Set=aaa
  5. &UniqueId=oss://testbucket1/test.pptx

此处的示例,目的是展示关键参数,还需要其他的公共参数才能正常调用,推荐使用 SDK 来发送 API。

成功返回示例

  1. {
  2. "RequestId": "2A91800E-77EE-4723-9D16-0727EC715A9B",
  3. "IndexCreatedTime": "2018-11-27T12:45:35.975Z",
  4. "IndexModifiedTime": "2018-11-27T12:45:45.975Z"
  5. "UniqueId": "oss://test/马克思主义哲学.doc",
  6. "SrcUri": "oss://test/马克思主义哲学.doc",
  7. "Name": "马克思主义哲学.doc",
  8. "ContentType": "doc",
  9. "LastModified": "2018-08-12T21:31:42.321Z",
  10. "Size": 878133,
  11. "PageNum": 12,
  12. "CustomKey1": "key1"
  13. "CustomKey2": "key2"
  14. "CustomKey3": "key3"
  15. "CustomKey4": "key4"
  16. "CustomKey5": "key5"
  17. "CustomKey6": "key6"
  18. }

若在使用中有疑问,请参考 FAQ,或者进入 钉钉用户群 实时交流。