搜索文件,最佳实践可参考:https://help.aliyun.com/document_detail/175890.html
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求语法
POST /v2/file/search
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
body | object | 否 | ||
drive_id | string | 是 | 空间 id | 1 |
query | string | 是 | 搜索条件,可以根据文件名或目录名模糊查询,最长 4096 字符 | not name=123 |
order_by | string | 否 | 排序字段,可选值如下: created_at:根据创建时间排序 updated_at:根据更新时间排序 size:根据文件大小排序 name:根据文件名排序 默认根据 created_at 排序 枚举值:
| name |
limit | integer | 否 | 限定此次返回资源的数量,取值范围[1,100]。 返回结果可以小于指定的数量,但不能多于指定的数量。 | 50 |
marker | string | 否 | 设定结果从marker之后按字母排序的第一个开始返回。如果不设定,则从头开始返回数据。
| NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg |
return_total_count | boolean | 否 | 是否返回检索到的文件总数。 | true |
返回参数
示例
正常返回示例
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": "共用文件",
"trashed_at": "2019-08-20T06:51:27.292Z",
"file_extension": "txt",
"mime_type": "video/quicktime",
"mime_extension": "mov",
"hidden": false,
"size": 1024,
"starred": false,
"status": "available",
"user_meta": "k1=v1,k2=v2",
"labels": [
""
],
"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",
"investigation_info": {
"status": 4,
"suggestion": "pass"
}
}
],
"next_marker": "NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg",
"total_count": 1022
}
错误码
访问错误中心查看更多错误码。