搜索数据集目录
POST /aids/aidmp/data/v2/dataSpaces/{data_space_id}/repos/{repo_id}/tree:search
请求头(Request Header)
请求参数(Request Parameters)
名称 | 类型 | 必须 | 位置 | 默认值 | 取值范围 | 描述 |
---|---|---|---|---|---|---|
data_space_id | string | 是 | path | - | - | 数据空间ID. |
repo_id | string | 是 | path | - | - | 数据集ID. |
请求体(Request Body)
名称 | 类型 | 必须 | 默认值 | 取值范围 | 描述 |
---|---|---|---|---|---|
repo_id | string | 是 | - | - | 数据集ID. |
branch_name | string | 否 | - | - | 分支名称. 若branch_name+commit_id均不传则默认 master 分支最新提交. |
branch_id | string | 否 | - | - | 分支ID. branch_id+branch_name两项都传则选branch_id为分支的最新提交. |
commit_id | string | 否 | - | - | 版本ID. 若branch_name+commit_id两项都传则以commit_id为准. |
path | string | 否 | - | - | 指定目录,不传则默认项目根目录. |
page_size | integer | 否 | 10 | 0-1000 | 本次请求的分页大小. |
page_token | string | 否 | - | - | 上次请求返回的next_page_token. |
query | string | 否 | - | - | 查询的字符串. |
path_prefix | string | 否 | - | - | 用于前缀匹配文件路径,获取某个文件夹下所有的文件,和path不会同时存在. |
without_commit | boolean | 否 | - | - | 用于判断返回的SingleFile是否要携带commit信息. |
start_file_path | string | 否 | - | - | 查询文件的起点,用于实现断点续传. |
file_name_pattern | string | 否 | - | - | 文件模糊查询,例如 train-00000-*.tar. |
contain_presign_uri | boolean | 否 | - | - | 判断是否返回文件链接. |
presign_uri_expired_sec | integer | 否 | - | - | 文件链接有效时间,秒单位. |
请求示例(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)
名称 | 类型 | 描述 |
---|---|---|
files | array[object] | 文件列表. |
next_page_token | string | 请求返回的 next_page_token. |
其中,file
的参数如下
名称 | 类型 | 描述 |
---|---|---|
file_name | string | 文件名. |
path | string | 路径. |
hash | string | 哈希值,目前为 SHA256. |
size | integer | 文件大小,以 Byte 为单位. |
type | integer($enum) | 同 HashNode.type,用于区分大小文件、文件夹. |
file_type | integer($enum) | 根据后缀判断的文件类型,文件夹没有该字段. |
commit | object | 所属 commit 信息. |
presign_uri | string | 文件链接. |
其中,type
有如下情况
状态 | 数值 | 含义 |
---|---|---|
DIR | 0 | 文件夹 |
FILE | 1 | 文件 |
TINY_FILE | 2 | 小文件 |
LARGE_FILE | 3 | 大文件 |
其中,file_type
有如下情况
状态 | 数值 | 含义 |
---|---|---|
OTHER | 0 | 其他 |
AUDIO | 1 | 音频 |
TEXT | 2 | 文本 |
IMAGE | 3 | 图片 |
VIDEO | 4 | 视频 |
PCD | 5 | 点云 |
其中,commit
的参数如下
名称 | 类型 | 描述 |
---|---|---|
id | string | 版本ID. |
repo_id | string | 数据集ID. |
depth | integer | 版本深度,第4个提交的深度是4. |
branch_id | string | 分支ID. |
pid | string | 上一个版本节点ID. |
merge_from | string | 从版本节点合并的版本节点信息. |
create_user_id | string | 创建者ID. |
create_user_name | string | 创建者用户名. |
commit_message | string | 版本提交信息. |
create_time | string($date-time) | 创建时间. |
update_time | string($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": ""
}