搜索数据集目录 | 大装置帮助中心
跳到主要内容

搜索数据集目录

POST /aids/aidmp/data/v2/dataSpaces/{data_space_id}/repos/{repo_id}/tree:search

请求头(Request Header)

参考认证(authentication)

请求参数(Request Parameters)

名称类型必须位置默认值取值范围描述
data_space_idstringpath--数据空间ID.
repo_idstringpath--数据集ID.

请求体(Request Body)

名称类型必须默认值取值范围描述
repo_idstring--数据集ID.
branch_namestring--分支名称. 若branch_name+commit_id均不传则默认 master 分支最新提交.
branch_idstring--分支ID. branch_id+branch_name两项都传则选branch_id为分支的最新提交.
commit_idstring--版本ID. 若branch_name+commit_id两项都传则以commit_id为准.
pathstring--指定目录,不传则默认项目根目录.
page_sizeinteger100-1000本次请求的分页大小.
page_tokenstring--上次请求返回的next_page_token.
querystring--查询的字符串.
path_prefixstring--用于前缀匹配文件路径,获取某个文件夹下所有的文件,和path不会同时存在.
without_commitboolean--用于判断返回的SingleFile是否要携带commit信息.
start_file_pathstring--查询文件的起点,用于实现断点续传.
file_name_patternstring--文件模糊查询,例如 train-00000-*.tar.
contain_presign_uriboolean--判断是否返回文件链接.
presign_uri_expired_secinteger--文件链接有效时间,秒单位.

请求示例(Request Example)

curl --location 'https://aidmp.cn-sh-01.sensecoreapi.dev/aids/aidmp/data/v2/dataSpaces/ecfcd941-575c-11ee-9d6f-46f164dda338/repos/22151ade-4c9f-4f11-a6a7-f67458aa1d0c/tree:search' \
--header 'Content-Type: application/json' \
--data '{
"page_token": "",
"page_size": 10,
"branch_name": "master",
"path": "",
"query": "123.txt"
}'

响应(Response)

名称类型描述
filesarray[object]文件列表.
next_page_tokenstring请求返回的 next_page_token.

其中,file的参数如下

名称类型描述
file_namestring文件名.
pathstring路径.
hashstring哈希值,目前为 SHA256.
sizeinteger文件大小,以 Byte 为单位.
typeinteger($enum)同 HashNode.type,用于区分大小文件、文件夹.
file_typeinteger($enum)根据后缀判断的文件类型,文件夹没有该字段.
commitobject所属 commit 信息.
presign_uristring文件链接.

其中,type有如下情况

状态数值含义
DIR0文件夹
FILE1文件
TINY_FILE2小文件
LARGE_FILE3大文件

其中,file_type有如下情况

状态数值含义
OTHER0其他
AUDIO1音频
TEXT2文本
IMAGE3图片
VIDEO4视频
PCD5点云

其中,commit的参数如下

名称类型描述
idstring版本ID.
repo_idstring数据集ID.
depthinteger版本深度,第4个提交的深度是4.
branch_idstring分支ID.
pidstring上一个版本节点ID.
merge_fromstring从版本节点合并的版本节点信息.
create_user_idstring创建者ID.
create_user_namestring创建者用户名.
commit_messagestring版本提交信息.
create_timestring($date-time)创建时间.
update_timestring($date-time)最后更新时间.

响应示例(Response Example)

{
"files": [
{
"file_name": "000000341230.jpg",
"path": ".",
"hash": "697704fcc99d944e4d65bf39cab0888d0e846cc9b98354191dd81ff76118a39a",
"size": "255670",
"type": 2,
"file_type": 3,
"commit": {
"id": "3a9bc532454e49dc9492bba57095767f",
"repo_id": "22151ade-4c9f-4f11-a6a7-f67458aa1d0c",
"depth": 4,
"branch_id": "5ed17144-7e65-4b4a-851a-de8e6f6957d3",
"pid": "5f1c8ca7c37d4c16aeb515c6ba338d8c",
"merge_from": "",
"create_user_id": "8c51e632-b68a-4c51-b80e-ec4a0963df26",
"create_user_name": "aidmpdev1user1",
"commit_message": "上传 000000341230.jpg",
"create_time": "2023-08-10T06:32:22.017Z",
"update_time": "2023-08-10T06:32:22.017Z"
}
}
],
"next_page_token": ""
}