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

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

功能介绍

查询数据集列表。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v1/{project_id}/datasets

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

获取方法请参考获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

name

否

String

数据集名称。

sort_dir

否

String

排序类别。

  • desc：代表减序。
  • asc：代表升序。

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：导出权限。
  • read：查看权限。
  • use：使用权限。

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：MySQL对应的数据源类型。
  • POSTGRESQL：PostgreSQL对应的数据源类型。
  • DWS：DWS对应的数据源类型。
  • OPENGAUSS：OpenGauss对应的数据源类型。
  • DLI：DLI对应的数据源类型。
  • CLICKHOUSE：ClickHouse对应的数据源类型。
  • API：API数据对应数据源类型。

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

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

错误码

请参见错误码。

父主题： 数据集

相关文档