QueryDatasetList - Quick BI - Alibaba Cloud Documentation Center

Queries the datasets in a specified workspace. The results are sorted in descending order by creation time.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

quickbi-public:QueryDatasetList

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	The workspace ID.	95296e95-ca89-4c7d-8af9-dedf0ad0****
DirectoryId	string	No	The ID of the folder. If you specify this parameter, all datasets in the folder are returned.	schemaad8aad00-9c55-4984-a767-b4e0ec60****
WithChildren	boolean	No	Specifies whether to recursively include datasets in subdirectories. Valid values: true: Returns all datasets in the folder specified by DirectoryId and its subdirectories. false: Returns only the datasets in the folder specified by DirectoryId.	true
Keyword	string	No	The keyword used to search for datasets by name.	test
PageNum	integer	No	The page number of the dataset list. Start value: 1 Default value: 1	1
PageSize	integer	No	The number of entries to return on each page. Default value: 10 Maximum value: 1000	10

Response elements

Element	Type	Description	Example
	object
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
RequestId	string	The request ID.	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	The paged results of the dataset list. The details of the datasets are returned in the Data parameter.
Data	array<object>	The details of the dataset list.
	array<object>
CreateTime	string	The time when the dataset was created.	2020-11-02 10:36:05
DataSource	object	The information about the data source to which the dataset belongs.
DsId	string	The data source ID.	261b252d-c3c3-498a-a0a7-5d1ec6cd****
DsName	string	The data source name.	test
DsType	string	The data source type.	mysql
DatasetId	string	The dataset ID.	5820f58c-c734-4d8a-baf1-7979af4f****
DatasetName	string	The dataset name.	company_sales_record_copy12
Description	string	The description of the dataset.	test
Directory	object	The information about the folder in which the dataset is located.
Id	string	The folder ID.	schemaad8aad00-9c55-4984-a767-b4e0ec60****
Name	string	The folder name.	test
PathId	string	The ID of the folder path.	schemaad8aad00-9c55-4984-a767-b4e0ec60****
PathName	string	The name of the folder path.	test
ModifyTime	string	The time when the dataset was last modified.	2020-11-02 10:36:05
OpenOfflineAcceleration	boolean	Indicates whether extraction-based acceleration is enabled. Valid values: true: Enabled false: Disabled	true
OwnerId	string	The user ID of the dataset owner in Quick BI.	136516262323****
OwnerName	string	The nickname of the dataset owner.	test
RowLevel	boolean	Indicates whether row-level permissions are enabled. Valid values: true: Enabled false: Disabled	true
WorkspaceId	string	The workspace ID.	95296e95-ca89-4c7d-8af9-dedf0ad06adf
WorkspaceName	string	The workspace name.	test
PageNum	integer	The page number.	1
PageSize	integer	The number of entries per page specified in the request.	10
TotalNum	integer	The total number of entries.	1
TotalPages	integer	The total number of pages.	1

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	Workspace.NotIn.Organization	The workspace is not owned by the organization.	The workspace is not owned by the organization.
400	CubeSchema.Not.Exist	The cube schema does not exist.	cube schema do not exists.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.