更新时间:2025-03-10 GMT+08:00
分享

查询数据集和目录列表

功能介绍

查询数据集列表。

URI

GET /v1/{project_id}/datasets

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

获取方法请参考获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

name

String

数据集名称。

sort_dir

String

是否降序。

sort_key

String

排序字段。

limit

Integer

返回条目数。不传该参数时,默认查询前10条信息。取值范围:[0,1000] 默认值:10。

offset

Integer

返回条目的起始offset。取值范围:[0,1000] 默认值:0。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Workspace-Id

String

工作空间ID。获取方法请参见获取工作空间ID

X-Auth-Token

String

用户Token。通过调用IAM服务获取IAM用户Token接口,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

count

Long

数据数量。

page_data

Array of 表5 objects

数据。

表5 DatasetListVO

参数

参数类型

描述

create_date

Long

创建时间。

create_user

String

创建人ID。

create_user_name

String

创建人姓名。

description

String

描述。

id

String

ID

name

String

名称。

permission_list

Array of strings

当前用户拥有的协同授权权限点。 edit,export,use,read。

project_id

String

项目ID。

type

String

数据集类型:

  • table:物理表组成的数据集。
  • sql:含自定义SQL表的数据集。

update_date

Long

修改时间。

update_user

String

修改人ID。

update_user_name

String

修改人姓名。

workspace_id

String

工作空间ID。

ds_name

String

绑定的数据源名称。

ds_type

String

绑定的数据源类型:MYSQL、POSTGRESQL、DWS、OPENGAUSS、CLICKHOUSE、API、DORIS

ds_id

String

绑定的数据源ID。

routing_strategy

String

查询数据时的路由策略。Direct:直连;Accelerator:内存引擎。

resource_code

String

数据集资源标识。

请求示例

GET https://{endpoint}/v1/{project_id}/datasets?limit=20&offset=0&sort_dir=desc&name=&create_user_name=&update_user_name=

响应示例

状态码:200

查询数据集和目录列表成功。

{ 
  "count" : 216, 
  "page_data" : [ { 
    "id" : "4df79d49-444c-xxxxx-28f9cfeac554", 
    "name" : "保存数据集", 
    "type" : "table", 
    "permission_list" : [ "edit", "use" ], 
    "workspace_id" : "e77ff0dxxxxxxx1b59fac2cc12faa146f", 
    "project_id" : "34ba64e53a02xxxxxxx75669a8cc17bd", 
    "create_user" : "558def45cexxxxxxxxa20e463e017", 
    "create_user_name" : "xxxxxxxxx", 
    "create_date" : 1704533906073, 
    "update_user" : "558def4xxxxxxxxx648a20e463e017", 
    "update_user_name" : "xxxxxxxx", 
    "update_date" : 1704533906073, 
    "description" : null, 
    "ds_id" : "ff8080818xxxxxxf101886aab31a900e1", 
    "ds_type" : "DWS", 
    "ds_name" : "dws04_public", 
    "routing_strategy" : "Direct", 
    "resource_code" : "xxx" 
  } ] 
}

状态码

状态码

描述

200

查询数据集和目录列表成功。

错误码

请参见错误码

相关文档