QueryDatasetList - 查询工作空间数据集列表

查询指定工作空间的数据集列表,按照创建时间倒序排列。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
WorkspaceIdstring

工作空间 ID。

95296e95-ca89-4c7d-8af9-dedf0ad0****
DirectoryIdstring

指定目录 ID。

  • 若该字段不为空,则获取该目录下的所有数据集。
schemaad8aad00-9c55-4984-a767-b4e0ec60****
WithChildrenboolean

是否递归包好子目录下的数据集。取值范围:

  • true:返回 directoryId 目录下所有递归子目录下的数据集。
  • false:仅返回 directoryId 指定目录下的数据集,不包含子目录下的。
true
Keywordstring

数据集名称搜索关键字。

测试数据集
PageNuminteger

数据集列表的当前页码:

  • 起始值:1
  • 默认值:1
1
PageSizeinteger

分页查询时的每页行数:

  • 默认值:10
  • 最大值:1000
10

返回参数

名称类型描述示例值
object
Successboolean

是否请求成功。取值范围:

  • true:请求成功
  • false:请求失败
true
RequestIdstring

请求 ID。

D787E1A3-A93C-424A-B626-C2B05DF8D885
Resultobject

返回数据集列表的分页结果,数据集列表的详细信息存放在返回参数 Data 中。

TotalPagesinteger

总页数。

1
PageNuminteger

页码。

1
PageSizeinteger

请求接口时设置的每页行数。

10
TotalNuminteger

总行数。

1
Dataarray<object>

数据集列表详情。

Dataobject
RowLevelboolean

是否开启行级权限。取值范围:

  • true:开启
  • false:关闭
true
WorkspaceIdstring

工作空间 ID。

95296e95-ca89-4c7d-8af9-dedf0ad06adf
Descriptionstring

数据集备注。

测试用数据集
CreateTimestring

创建时间。

2020-11-02 10:36:05
OwnerNamestring

数据集拥有者的昵称。

张三
WorkspaceNamestring

工作空间名称。

测试空间
OwnerIdstring

数据集拥有者在 Quick BI 的 UserID。

136516262323****
ModifyTimestring

修改时间。

2020-11-02 10:36:05
DatasetNamestring

数据集名称。

company_sales_record_copy12
DatasetIdstring

数据集 ID。

5820f58c-c734-4d8a-baf1-7979af4f****
OpenOfflineAccelerationboolean

是否开启抽取加速。取值范围:

  • true:开启
  • false:关闭
true
DataSourceobject

数据集所属数据源信息

DsTypestring

数据源类型。

mysql
DsNamestring

数据源名称。

测试数据源
DsIdstring

数据源 ID。

261b252d-c3c3-498a-a0a7-5d1ec6cd****
Directoryobject

数据集所处目录信息

PathIdstring

所处目录路径的 ID。

schemaad8aad00-9c55-4984-a767-b4e0ec60****
PathNamestring

所处目录路径的名称。

我的数据集目录
Namestring

目录名称。

我的数据集目录
Idstring

目录 ID。

schemaad8aad00-9c55-4984-a767-b4e0ec60****

示例

正常返回示例

JSON格式

{
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "TotalPages": 1,
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "Data": [
      {
        "RowLevel": true,
        "WorkspaceId": "95296e95-ca89-4c7d-8af9-dedf0ad06adf",
        "Description": "测试用数据集",
        "CreateTime": "2020-11-02 10:36:05",
        "OwnerName": "张三",
        "WorkspaceName": "测试空间",
        "OwnerId": "136516262323****",
        "ModifyTime": "2020-11-02 10:36:05",
        "DatasetName": "company_sales_record_copy12",
        "DatasetId": "5820f58c-c734-4d8a-baf1-7979af4f****",
        "OpenOfflineAcceleration": true,
        "DataSource": {
          "DsType": "mysql",
          "DsName": "测试数据源",
          "DsId": "261b252d-c3c3-498a-a0a7-5d1ec6cd****"
        },
        "Directory": {
          "PathId": "schemaad8aad00-9c55-4984-a767-b4e0ec60****",
          "PathName": "我的数据集目录",
          "Name": "我的数据集目录",
          "Id": "schemaad8aad00-9c55-4984-a767-b4e0ec60****"
        }
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400Workspace.NotIn.OrganizationThe workspace is not owned by the organization.空间不在组织内。
400CubeSchema.Not.ExistThe cube schema does not exist.数据集模型不存在。
400Internal.System.ErrorAn internal system error occurred.系统内部异常。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-05-22OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情