查询数据列表
功能介绍
查询指定目录下的数据列表,如果不指定默认查询根目录。
URI
GET /v1/{project_id}/eihealth-projects/{eihealth_project_id}/datas
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
eihealth_project_id |
是 |
String |
参数解释: 空间ID,您可以在平台单击所需的空间名称,进入空间设置页面查看。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 |
project_id |
是 |
String |
参数解释: 项目ID,您可以从获取项目ID中获取。 约束限制: 不涉及 取值范围: 仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
否 |
Integer |
参数解释: 限制量,单次查询总量。 约束限制: 不涉及 取值范围: [1-1000] 默认取值: 100 |
offset |
否 |
Integer |
参数解释: 偏移量,查询起始偏移。 约束限制: 不涉及 取值范围: [0-100000000] 默认取值: 0 |
path |
否 |
String |
参数解释: 指定文件夹(空间名称:/路径)。 约束限制: 不涉及 取值范围: 长度为[0-2000]个字符。 默认取值: 不涉及 |
search_key |
否 |
String |
参数解释: 查询关键词。 约束限制: 不涉及 取值范围: 长度为[0-2000]个字符。 默认取值: 不涉及 |
sort_dir |
否 |
String |
参数解释: 排序规则。 约束限制: 不涉及 取值范围:
默认取值: desc |
sort_key |
否 |
String |
参数解释: 排序字段。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
marker |
否 |
String |
参数解释: 开始标签。 约束限制: 不涉及 取值范围: 长度为[0-2000]个字符。 默认取值: 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。 约束限制: 不涉及 取值范围: 长度为[1-32768]个字符。 默认取值: 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
count |
Long |
参数解释: 数据对象(目录、文件)总数量。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
datas |
Array of DataSummaryRsp objects |
参数解释: 数据对象列表。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
next_marker |
String |
参数解释: 下一页开始标签。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
path |
String |
参数解释: 对象全路径(空间名称:/路径)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
name |
String |
参数解释: 名称。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
type |
String |
参数解释: 路径类型。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
size |
Long |
参数解释: 大小。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 0 |
create_time |
String |
参数解释: 创建时间。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
allowed_operate |
Boolean |
参数解释: 可操作标记。 约束限制: 不涉及 取值范围: 不涉及 默认取值: true |
deletable |
Boolean |
参数解释: 可删除标记。 约束限制: 不涉及 取值范围: 不涉及 默认取值: true |
请求示例
查询数据列表。
https://{endpoint}/v1/{project_id}/eihealth-projects/{eihealth_project_id}/datas
响应示例
状态码:200
OK
{ "count" : 1, "datas" : [ { "path" : "test-project-id:/db_test1.txt", "name" : "db_test1.txt", "type" : "FILE", "size" : 1024, "create_time" : "2021-02-01T14:25:34Z", "allowed_operate" : true, "deletable" : true } ], "next_marker" : "text-01" }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
错误码
请参见错误码。