文档首页/ 智能数据洞察 DataArts Insight/ API参考/ 数据集/ 查询数据集和目录列表
更新时间：2024-08-05 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询数据集和目录列表

功能介绍

查询数据集列表。

URI

GET /v1/{project_id}/datasets

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

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

最小长度：0

最大长度：128
表2 Query参数

参数

是否必选

参数类型

描述

name

否

String

数据集名称。

最小长度：0

最大长度：128

sort_dir

否

String

是否降序。

最小长度：0

最大长度：128

sort_key

否

String

排序字段。

最小长度：0

最大长度：128

limit

否

Integer

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

最小值：0

最大值：1000

offset

否

Integer

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

最小值：0

最大值：1000

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Workspace-Id

是

String

工作空间ID，即控制台的项目ID。

最小长度：0

最大长度：128

X-Auth-Token

是

String

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

最小长度：0

最大长度：8192

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

count

Long

数据数量。

最小值：0

最大值：2147483647

page_data

Array of 表5 objects

数据

数组长度：0-2147483647
表5 DatasetListVO

参数

参数类型

描述

create_date

Long

创建时间。

最小值：0

最大值：9223372036854774807

create_user

String

创建人ID。

最小长度：0

最大长度：128

create_user_name

String

创建人姓名。

最小长度：0

最大长度：128

description

String

描述。

最小长度：0

最大长度：1024

id

String

ID

最小长度：0

最大长度：128

name

String

名称。

最小长度：0

最大长度：128

permission_list

Array of strings

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

最小长度：0

最大长度：128

数组长度：0-10000

project_id

String

项目ID。

最小长度：0

最大长度：128

type

String

类型：datasource，dataset，dashboard，screen。

最小长度：0

最大长度：128

update_date

Long

修改时间。

最小值：0

最大值：9223372036854774807

update_user

String

修改人ID。

最小长度：0

最大长度：128

update_user_name

String

修改人姓名。

最小长度：0

最大长度：128

workspace_id

String

工作空间ID。

最小长度：0

最大长度：128

ds_name

String

绑定的数据源名称。

最小长度：0

最大长度：255

ds_type

String

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

最小长度：0

最大长度：64

枚举值：

  • MYSQL
  • POSTGRESQL
  • DWS
  • OPENGAUSS
  • DLI
  • CLICKHOUSE
  • API
  • DORIS

ds_id

String

绑定的数据源ID。

最小长度：0

最大长度：64

routing_strategy

String

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

最小长度：0

最大长度：32

resource_code

String

数据集资源标识。

最小长度：0

最大长度：64

请求示例

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

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

错误码

请参见错误码。

父主题： 数据集

相关文档