调用QueryDatasetList查询工作空间数据集列表_智能商业分析 Quick BI(Quick BI)-阿里云帮助中心

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

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
quickbi-public:QueryDatasetList	list	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
WorkspaceId	string	是	工作空间 ID。	95296e95-ca89-4c7d-8af9-dedf0ad0****
DirectoryId	string	否	指定目录 ID。若该字段不为空，则获取该目录下的所有数据集。	schemaad8aad00-9c55-4984-a767-b4e0ec60****
WithChildren	boolean	否	是否递归包好子目录下的数据集。取值范围： true：返回 directoryId 目录下所有递归子目录下的数据集。 false：仅返回 directoryId 指定目录下的数据集，不包含子目录下的。	true
Keyword	string	否	数据集名称搜索关键字。	测试数据集
PageNum	integer	否	数据集列表的当前页码：起始值：1 默认值：1	1
PageSize	integer	否	分页查询时的每页行数：默认值：10 最大值：1000	10

返回参数

名称	类型	描述	示例值
	object
Success	boolean	是否请求成功。取值范围： true：请求成功 false：请求失败	true
RequestId	string	请求 ID。	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	返回数据集列表的分页结果，数据集列表的详细信息存放在返回参数 Data 中。
TotalPages	integer	总页数。	1
PageNum	integer	页码。	1
PageSize	integer	请求接口时设置的每页行数。	10
TotalNum	integer	总行数。	1
Data	array<object>	数据集列表详情。
Data	object
RowLevel	boolean	是否开启行级权限。取值范围： true：开启 false：关闭	true
WorkspaceId	string	工作空间 ID。	95296e95-ca89-4c7d-8af9-dedf0ad06adf
Description	string	数据集备注。	测试用数据集
CreateTime	string	创建时间。	2020-11-02 10:36:05
OwnerName	string	数据集拥有者的昵称。	张三
WorkspaceName	string	工作空间名称。	测试空间
OwnerId	string	数据集拥有者在 Quick BI 的 UserID。	136516262323****
ModifyTime	string	修改时间。	2020-11-02 10:36:05
DatasetName	string	数据集名称。	company_sales_record_copy12
DatasetId	string	数据集 ID。	5820f58c-c734-4d8a-baf1-7979af4f****
OpenOfflineAcceleration	boolean	是否开启抽取加速。取值范围： true：开启 false：关闭	true
DataSource	object	数据集所属数据源信息
DsType	string	数据源类型。	mysql
DsName	string	数据源名称。	测试数据源
DsId	string	数据源 ID。	261b252d-c3c3-498a-a0a7-5d1ec6cd****
Directory	object	数据集所处目录信息
PathId	string	所处目录路径的 ID。	schemaad8aad00-9c55-4984-a767-b4e0ec60****
PathName	string	所处目录路径的名称。	我的数据集目录
Name	string	目录名称。	我的数据集目录
Id	string	目录 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	错误码	错误信息	描述
400	Workspace.NotIn.Organization	The workspace is not owned by the organization.	空间不在组织内。
400	CubeSchema.Not.Exist	The cube schema does not exist.	数据集模型不存在。
400	Internal.System.Error	An internal system error occurred.	系统内部异常。

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

变更历史

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