搜索文件。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST /v2/file/search HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| domain_id |
string |
是 |
||
| body |
object |
否 |
请求体参数。 |
|
| drive_id |
string |
否 |
空间 id |
1 |
| query |
string |
是 |
搜索条件，可以根据文件名或目录名模糊查询，最长 4096 字符 |
name="123" |
| order_by |
string |
否 |
排序字段，默认根据 created_at 排序，可选值如下：
排序方向，可选值如下：
order_by 语法为：字段名+空格+ASC/DESC，如果多个字段排序则需要用逗号隔开，前面的规则优先级高。如：
|
name ASC |
| limit |
integer |
否 |
限定此次返回资源的数量，取值范围[1,100]。 返回结果可以小于指定的数量，但不能多于指定的数量。 |
50 |
| marker |
string |
否 |
设定结果从 marker 之后按字母排序的第一个开始返回。如果不设定，则从头开始返回数据。
|
NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg |
| return_total_count |
boolean |
否 |
是否返回检索到的文件总数。 |
true |
| recursive |
boolean |
否 |
当 query 中设置了 parent_file_id= xxx 时，设置该字段可以对文件夹进行递归搜索 |
true |
| thumbnail_processes |
object |
否 |
缩略图配置，可一次性返回最多 5 个缩略图，map 的 key 可以自定义，返回时按 key 返回对应的缩略图链接 |
|
| ImageProcess |
否 |
定义图片、视频、文档的缩略图处理规则 |
||
| fields |
string |
否 |
设置 fields 时，可以返回文件的额外信息时，支持的字段为：
当需要多个信息时，不同字段以逗号分割，如 "id_path,name_path,dir_size" |
id_path,name_path |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| items |
array |
文件信息列表。 |
|
| File |
文件信息 |
||
| next_marker |
string |
下一页起始资源标识符, 最后一页该值为空。 |
NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg |
| total_count |
integer |
命中的文件总数 |
1022 |
示例
正常返回示例
JSON格式
{
"items": [
{
"domain_id": "bj1",
"drive_id": "1",
"file_id": "5d79206586bb5dd69fb34c349282718146c55da7",
"name": "1.mov",
"type": "file",
"content_type": "application/json",
"created_at": "2019-08-20T06:51:27.292Z",
"updated_at": "2019-08-20T06:51:27.292Z",
"description": "image file",
"trashed_at": "2019-08-20T06:51:27.292Z",
"file_extension": "txt",
"hidden": false,
"size": 1024,
"starred": false,
"status": "available",
"labels": [
"[\"label1:1\", \"label2:2\"]"
],
"upload_id": "C9DCFE5A82644AC7A02DB74C30C934A6",
"parent_file_id": "3d5b846942cf94fa72324c8a4bda34e81da635a",
"crc64_hash": "3574582125365864471",
"content_hash": "EA4942AA8761213890A5C386F88E6464D2C31CA3",
"content_hash_name": "sha1",
"download_url": "https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
"thumbnail": "https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx",
"category": "image",
"local_created_at": "2019-08-20T06:51:27.292Z",
"local_modified_at": "2019-08-20T06:51:27.292Z",
"revision_id": "5d5b846942cf94fa72324c14a4bda34e81da635d",
"thumbnail_urls": {
"key": "\"128X128\": \"https://url1\", \"800X800\": \"url2\""
},
"image_media_metadata": {
"time": "2006-01-02T15:04:05.000Z07:00",
"width": 1024,
"height": 1024,
"location": "30.185453,120.218522",
"country": "China",
"province": "Zhejiang",
"city": "Hangzhou",
"district": "Xihu",
"township": "Xihu",
"address_line": "Zhejiang hangzhou xihu",
"image_tags": [
{
"confidence": 0.98,
"parent_name": "sport",
"name": "basketball",
"tag_level": 3,
"source": "play basketball",
"centric_score": 0.877
}
],
"faces": "[{\"FaceId\":\"a9a66a86-73dd-4c95-8b79-1d8a49db5226\",\"GroupId\":\"Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0\",\"FaceConfidence\":0.999,\"Age\":13,\"AgeConfidence\":4,\"Gender\":\"female\",\"GenderConfidence\":1,\"Emotion\":\"none\",\"EmotionConfidence\":0.672,\"FaceAttributes\":{\"Mask\":\"none\",\"MaskConfidence\":0.894,\"Beard\":\"none\",\"BeardConfidence\":0.997,\"Glasses\":\"none\",\"GlassesConfidence\":0.999,\"Mouth\":\"close\",\"MouthConfidence\":0.937,\"Hat\":\"none\",\"HatConfidence\":0.998,\"HeadPose\":{\"Pitch\":10.684,\"Roll\":-10.707,\"Yaw\":-20.094},\"FaceBoundary\":{\"Width\":457,\"Height\":687,\"Top\":1324,\"Left\":1356}}}]",
"faces_thumbnail": [
{
"face_id": "a9a66a86-73dd-4c95-8b79-1d8a49db5226",
"face_group_id": "Cluster-e3b7fb52-22b3-44f2-9746-8c1804bd6af0",
"face_thumbnail": "https://pds-domain.region.aliyuncs.com/QieGeH98%2F1001%2F63e5e551ee621482ab934a0687c6cda75fc07864%2F642a8a40c00f1ad379df421694713ee65170f09b?security-token=CAIS%2BgF1q6Ft5B2yfSjIr5bjHPCNnrdR8aSaSW7woVlmVd1Bt5HorDz2IHpPfHdoBe0btvU%2BlWxX6fwZlq5rR4QAXlDfNSyFeX20qFHPWZHInuDox55m4cTXNAr%2BIhr%2F29CoEIedZdjBe%2FCrRknZnytou9XTfimjWFrXWv%2Fgy%2BQQDLItUxK%2FcCBNCfpPOwJms7V6D3bKMuu3OROY6Qi5TmgQ41En1DIlt%2FXuk5DCtkqB12eXkLFF%2B97DRbG%2FdNRpMZtFVNO44fd7bKKp0lQLsUMSqv8q0fEcqGaW4o7CWQJLnzyCMvvJ9OVDFyN0aKEnH7J%2Bq%2FzxhTPrMnpkSlacGoABPMvZ8rSESUEP96Vbf%2Bk0JRg9Qb1MnaIJqWAgo8K6K0UP1CtqL2zrUtugpKKDHOYiKbq2O0S5yLUPVX5vBHqEi%2FFc7i6ZnHCMcXLJs4rKDKwRBEhovUXXlklq2q43OSVtLrXkBy9Xs1ers%2FhJhcxpNA0Vl3EWfJxa2BTylEdnLOQ%3D&x-oss-access-key-id=STS.NUVWJ9shpFfqKHAEY3YRmXTCN&x-oss-expires=1686455451&x-oss-process=image%2Fcrop%2Cx_1128%2Cy_1211%2Cw_914%2Ch_914%2Fformat%2Cjpg&x-oss-signature=jmhOz91Tww1ciMEwadDiioU7d93FDiBNr8s8mHyMqW0%3D&x-oss-signature-version=OSS2"
}
],
"exif": "{\"Compression\":{\"value\":\"6\"},\"DateTime\":{\"value\":\"2020:08:19 17:11:11\"}}",
"image_quality": {
"overall_score": 0.736
}
},
"user_tags": {
"key": "\"k1\":\"v1\", \"k2\",\"v2\""
},
"video_media_metadata": {
"time": "2006-01-02T15:04:05.000Z07:00",
"width": 1920,
"height": 1080,
"location": "30.185453,120.218522",
"country": "China",
"province": "Zhejiang",
"city": "Hangzhou",
"district": "Xihu",
"township": "Xihu",
"address_line": "Zhejiang hangzhou xihu",
"video_media_video_stream": [
{
"duration": "22.88",
"bitrate": "108420",
"code_name": "h264",
"frame_count": "90"
}
],
"video_media_audio_stream": [
{
"duration": "7704.573000",
"bit_rate": "129280",
"code_name": "aac"
}
]
},
"id_path": "id1/id2",
"name_path": "root/f1/f2",
"dir_size_info": {
"dir_count": 1,
"file_count": 10
},
"action_list": [
""
],
"auto_delete_left_sec": 0
}
],
"next_marker": "NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg",
"total_count": 1022
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。