Filter and Retrieve Datasets via ListDatasets API - DataWorks - Alibaba Cloud - DataWorks

Queries a list of datasets. Currently, DataWorks datasets and PAI datasets are supported.

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

dataworks:ListDatasets

list

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	No	The DataWorks workspace ID.	251363
Origin	string	No	The dataset source. Valid values: DataWorks PAI	DataWorks
Name	string	No	The dataset name. Supports fuzzy search.	test_dataset
DataTypeList	array	No	The data type. Multiple selections are allowed. Valid values: COMMON PIC TEXT TABLE VIDEO AUDIO INDEX
	string	No	Data types Valid values: TABLE: Table. VIDEO: Video. COMMON: Common. TEXT: Text. PIC: Image. INDEX: Index. AUDIO: Audio. Valid values: TABLE : VIDEO : COMMON : TEXT : PIC : INDEX : AUDIO :	COMMON
StorageTypeList	array	No	The storage type. Multiple selections are allowed. Supported values: OSS NAS: General-purpose NAS file systems EXTREMENAS: Extreme NAS file systems DLF_LANCE: Data Lake Formation CPFS: Cloud Parallel File Storage BMCPFS: CPFS for Lingjun MAXCOMPUTE: MaxCompute table Valid values: NAS : MAXCOMPUTE : CPFS : BMCPFS : EXTREMENAS : OSS : DLF_LANCE :
	string	No	The storage type.	NAS
CreatorId	string	No	The creator ID.	12103XXX46492139
SortBy	string	No	The sort field. Default: CreateTime. Valid values: ModifyTime: Modification time. CreateTime: Creation time. Name Valid values: ModifyTime : CreateTime : Name :	CreateTime
Order	string	No	The sort order. Default: Desc. Valid values: Asc: Ascending. Desc: Descending. Valid values: Asc : Desc :	Asc
PageNumber	integer	No	The page number. Default: 1.	1
PageSize	integer	No	The number of entries per page. Default: 10. Maximum: 100.	10

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	RequestId	6A6CBE87-9F91-1323-B680-E7A7065XXXXX
Success	boolean	Indicates whether the request was successful.	true
PagingInfo	object	The pagination information.
TotalCount	integer	The total number of entries returned.	100
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries on this page.	10
Datasets	array	The dataset list.
	Dataset	The dataset object.

Examples

Success response

JSON format

{
  "RequestId": "6A6CBE87-9F91-1323-B680-E7A7065XXXXX\n",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 100,
    "PageNumber": 1,
    "PageSize": 10,
    "Datasets": [
      {
        "Id": "",
        "Name": "",
        "Comment": "",
        "ProjectId": 0,
        "Origin": "",
        "DataType": "",
        "StorageType": "",
        "CreatorId": "",
        "Readme": "",
        "LatestVersion": {
          "Id": "dataworks-datasetVersion:0gfxxxjx155usz3hrv:1",
          "DatasetId": "dataworks-datasetVersion:0gfxxxjx155usz3hrv",
          "Comment": "Initial version",
          "CreatorId": "17815XXX61016173",
          "VersionNumber": 1,
          "StorageType": "OSS",
          "Url": "oss://test-oss-bucket/test_dir/",
          "MountPath": "/mnt/data",
          "CreateTime": 1736756055000,
          "ModifyTime": 1736756055000,
          "Labels": [
            {
              "Key": "key1",
              "Value": "value1"
            }
          ],
          "ImportInfo": {
            "key": "None"
          }
        },
        "CreateTime": 0,
        "ModifyTime": 0,
        "Labels": [
          {
            "Key": "key1",
            "Value": "value1"
          }
        ]
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.