SearchDocIndex
SearchDocIndex
搜索索引。(当前只支持上海 Region)
请求参数
名称 | 类型 | 是否必填 | 描述 |
---|---|---|---|
Action | String | 是 | SearchDocIndex |
Project | String | 是 | 项目名 |
Set | String | 是 | 集合名,存储索引文档的容器 |
Content | String | 否 | 全文搜索文档内容 |
Name | String | 否 | 全文搜索文件名称 |
ContentType | String | 否 | 精确搜索文件类型 |
ModifiedTimeStart | integer | 否 | Unitx 时间戳,精确到秒。搜索文件修改时间,大于等于 ModifiedTimeStart |
ModifiedTimeEnd | integer | 否 | Unitx 时间戳,精确到秒。搜索文件修改时间,小于 ModifiedTimeEnd |
SizeLimitStart | integer | 否 | 搜索文件大小,大于等于 SizeLimitStart |
SizeLimitEnd | integer | 否 | 搜索文件大小,小于 SizeLimitEnd |
PageNumLimitStart | integer | 否 | 搜索文件页数,大于等于 PageNumLimitStart |
PageNumLimitEnd | integer | 否 | 搜索文件页数,小于 PageNumLimitEnd |
CustomKey1 | String | 否 | 如果设置,则前缀匹配 Key1 |
CustomKey2 | String | 否 | 如果设置,则前缀匹配 Key2 |
CustomKey3 | String | 否 | 如果设置,则精确匹配 Key3 |
CustomKey4 | String | 否 | 如果设置,则精确匹配 Key4 |
CustomKey5 | String | 否 | 如果设置,则全文匹配 Key5 |
CustomKey6 | String | 否 | 如果设置,则全文匹配 Key6 |
Offset | interger | 否 | 返回的数据从 Offset 开始,默认为 0 |
Limit | interger | 否 | 返回的数据条数,合法的值为 [10, 200] |
返回参数
名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 用户发送的每次接口调用请求,无论成功与否,系统都会返回一个唯一识别码 RequestId 给用户 |
DocInfos | Array | 匹配的文档信息数组 |
UniqueId | String | 文档唯一 ID |
SrcUri | String | 提交索引时的 SrcUri |
Name | String | 文档名称 |
ContentType | String | 文档类型 |
LastModified | String | 文档修改时间 |
Size | Integer | 文档大小 |
PageNum | Integer | 文档页数 |
CustomKey1 | String | 支持前缀匹配的 Key1,可以存储文件系统路径,用来搜索指定范围的数据 |
CustomKey2 | String | 支持前缀匹配的 Key2,可以存储文件系统路径,用来搜索指定范围的数据 |
CustomKey3 | String | 支持精准匹配的 Key3 |
CustomKey4 | String | 支持精准匹配的 Key4 |
CustomKey5 | String | 支持全文检索的 Key5,可以存储标签等 |
CustomKey6 | String | 支持全文检索的 Key6,可以存储标签等 |
示例
请求示例
POST https://imm.cn-shanghai.aliyuncs.com
?Action=SearchDocIndex
&Project=test
&Set=aaa
&Content=你好
...
此处的示例,目的是展示关键参数,还需要其他的公共参数才能正常调用,推荐使用 SDK 来发送 API。
成功返回示例
{
"RequestId": "B26CCA36-C316-495F-B524-D3A89BF4D0B0",
"DocInfos":
{
"UniqueId": "oss://test/马克思主义哲学.doc",
"SrcUri": "oss://test/马克思主义哲学.doc",
"Name": "马克思主义哲学.doc",
"ContentType": "doc",
"LastModified": "2018-08-12T21:31:42.321Z",
"Size": 878133,
"PageNum": 12,
"CustomKey1": "key1"
"CustomKey2": "key2"
"CustomKey3": "key3"
"CustomKey4": "key4"
"CustomKey5": "key5"
"CustomKey6": "key6"
},
{
"UniqueId": "oss://test/社会主义思想.ppt",
"SrcUri": "oss://test/社会主义思想.ppt",
"Name": "社会主义思想.ppt",
"ContentType": "ppt",
"LastModified": "2018-08-13T12:11:22.133Z",
"Size": 1235231,
"PageNum": 26,
"CustomKey1": "key1"
"CustomKey2": "key2"
"CustomKey3": "key3"
"CustomKey4": "key4"
"CustomKey5": "key5"
"CustomKey6": "key6"
}
]
}
版权声明
本文仅代表作者观点,不代表本站立场。
本文系作者授权发表,未经许可,不得转载。
评论