文档首页/ 智能数据洞察 DataArts Insight/ API参考/ 数据集/ 查询数据集和目录列表 - ListCubeAndCatalogList
更新时间：2025-11-25 GMT+08:00
查看PDF
分享

查询数据集和目录列表 - ListCubeAndCatalogList

功能介绍

查询数据集列表。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /v1/{project_id}/datasets

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

name

否

String

参数解释：

数据集名称。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

sort_dir

否

String

参数解释：

排序类型。

约束限制：

不涉及

取值范围：

  • asc: 升序

  • desc: 降序

默认取值：

asc

sort_key

否

String

参数解释：

排序字段。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

limit

否

Integer

参数解释：

返回条目数。

约束限制：

不涉及

取值范围：

[1, 1000]

默认取值：

10

offset

否

Integer

参数解释：

偏移量。

约束限制：

不涉及

取值范围：

[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 DatasetListVO 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

  • DLI

  • 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" : "xxxxxxx-444c-4dfb-bd17-28f9cfeac554",
    "name" : "保存数据集",
    "type" : "table",
    "permission_list" : [ "edit", "use" ],
    "workspace_id" : "e77fxxxxxxxxxxxxxxx2faa146f",
    "project_id" : "34baxxxxxxxxxxxxxa8cc17bd",
    "create_user" : "55xxxxxxxxxxxxxx463e017",
    "create_user_name" : "exxxxxxxxx",
    "create_date" : 1704533906073,
    "update_user" : "5xxxxxxxxxxxxx017",
    "update_user_name" : "ei_xxxxxxxxxxxx_01",
    "update_date" : 1704533906073,
    "description" : null,
    "ds_id" : "ff80xxxxxxxxxxxxxxxxxxx00e1",
    "ds_type" : "DWS",
    "ds_name" : "dws04_public",
    "routing_strategy" : "Direct",
    "resource_code" : "xxx"
  } ]
}

状态码

状态码

描述

200

查询数据集列表成功。

错误码

请参见错误码。

父主题： 数据集

相关文档