首页 Quick BI 开发参考 API参考(专业版) API目录 数据集资源管理 QueryDatasetList - 查询工作空间数据集列表

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

更新时间: 2023-06-27 16:37:41

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

调试

您可以在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
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****
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****",
        "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错误码错误信息描述
400Instance.ExpiredYour instance has expired.您的购买实例已经过期。
400Instance.Not.ExistThe specified instance does not exist.暂未匹配到您的购买实例。
400Access.ForbiddenAccess forbidden. Your instance version or access key is not allowed to call the API operation.-
400Invalid.OrganizationThe specified organizational unit does not exist.该组织不存在。
400User.Not.In.OrganizationThe specified user is not in the organizational unit.该用户不在组织中。
400Invalid.Param.ErrorThe parameter is invalid.无效参数。
400Workspace.NotIn.OrganizationThe workspace is not owned by the organization.空间不在组织内。
400CubeSchema.Not.ExistThe cube schema does not exist.数据集模型不存在。
400System.Param.EmptyYou must specify the %s parameter.参数%s不能为空。
400Internal.System.ErrorAn internal system error occurred.系统内部异常。
400Invalid.ParameterAn error occurred while verifying parameters.参数验证失败。
400Invalid.Parameter.ErrorThe parameter is invalid:%s.无效参数%s。
400Invalid.User.AdminYou are not an administrator of this organization.没有权限,您不是组织管理员。
400UserInfo.ErrorThe personal information is invalid.个人信息不合法。
400ApiUser.Not.ExistsThe specified user does not exist.用户不存在。

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

阿里云首页 Quick BI 相关技术圈