ListDatasets - Platform For AI - Alibaba Cloud Documentation Center

Lists the datasets in a workspace.

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

paidataset:ListDatasets

list

*All Resource

*

None

Request syntax

GET /api/v1/datasets HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number of the dataset list. The value starts from 1. The default value is 1.	1
PageSize	integer	No	The number of entries to return on each page for a paged query. The default value is 10.	10
Order	string	No	The order in which to sort the results of a paged query on a specified field. The default value is ASC. ASC: ascending order. DESC: descending order. Valid values: ASC : ASC DESC : DESC	ASC
Name	string	No	The name of the dataset. Fuzzy search by dataset name is supported.	myName
Properties	string	No	The properties of the dataset. Separate multiple properties with commas (,). Valid values: DIRECTORY: folder. FILE: file. Valid values: DIRECTORY : DIRECTORY FILE : FILE	FILE
DataSourceTypes	string	No	The type of the data source. Separate multiple types with commas (,). Valid values: NAS: The data is stored in Alibaba Cloud File Storage (NAS). OSS: The data is stored in Alibaba Cloud Object Storage Service (OSS). Valid values: NAS : NAS OSS : OSS	OSS
DataTypes	string	No	The data type of the dataset. Separate multiple data types with commas (,). Valid values: VIDEO: video. COMMON: general. TEXT: text. PIC: image. AUDIO: audio. Valid values: VIDEO : VIDEO COMMON : COMMON TEXT : TEXT PIC : PIC AUDIO : AUDIO	COMMON,TEXT
SourceId	string	No	The ID of the data source. If SourceTypes is set to USER, you can customize the SourceId. If SourceTypes is set to ITAG, which indicates a dataset generated from iTAG annotation results, the SourceId is the task ID from iTAG. If SourceTypes is set to PAI_PUBLIC_DATASET, which indicates a dataset created from a PAI public dataset, the SourceId is empty by default.	d-rbvg5wzljzjhc9ks92
SourceTypes	string	No	The source type. Separate multiple types with commas (,). Valid values: PAI_PUBLIC_DATASET : PAI_PUBLIC_DATASET ITAG : ITAG USER : USER	USER,ITAG
WorkspaceId	string	No	The ID of the workspace where the dataset resides. For more information about how to obtain a workspace ID, see ListWorkspaces. If you do not configure this parameter, the default workspace is used. If the default workspace does not exist, an error is reported.	324**
Label	string	No	The dataset label, which is used to filter the dataset list. Datasets are filtered if their label keys or values contain the specified string.	test
Provider	string	No	The provider of the dataset. If the return value is "pai", the dataset is a public dataset on the PAI platform.	pai
SourceDatasetId	string	No	The source dataset ID for an iTAG annotation set.	d-rcdg3wxxxxxhc5jk87
SortBy	string	No	The field to sort by. Valid values: DataSourceType : DataSourceType DataType : DataType GmtCreateTime : GmtCreateTime GmtModifiedTime : GmtModifiedTime	GmtCreateTime
ShareScope	string	No	A filter for shared datasets: TO_ME: Filters for datasets shared with you. BY_ME: Filters for datasets you have shared with others. The details of the sharing configuration are displayed. If this parameter is not set or is left empty, all datasets in the current workspace are retrieved, including those shared with you (TO_ME). Valid values: TO_ME : TO_ME BY_ME : BY_ME	BY_ME
Edition	string	No	The dataset type. Enumeration values: BASIC: Basic. Does not support dataset file metadata management. ADVANCED: Advanced. Only supported for OSS datasets. Each version supports metadata management for up to 1 million files. LOGICAL: Logical. Only supported for OSS datasets. Each version supports metadata management for up to 1 million files. This type is suitable for most scenarios and must be used with an SDK. Valid values: LOGICAL : LOGICAL BASIC : BASIC ADVANCED : ADVANCED	BASIC
Accessibility	string	No	The visibility of the dataset. PUBLIC: public. PRIVATE: private. Valid values: PUBLIC : PUBLIC PRIVATE : PRIVATE	PRIVATE

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	5A14FA81-DD4E-******-6343FE44B941
Datasets	array	The list of datasets.
	Dataset	A dataset.
TotalCount	integer	The total number of entries.	15

Examples

Success response

JSON format

{
  "RequestId": "5A14FA81-DD4E-******-6343FE44B941",
  "Datasets": [
    {
      "DatasetId": "d-c0h44g3****j8o4348",
      "UserId": "2485765****023475",
      "OwnerId": "1631044****3440",
      "Name": "myName",
      "Labels": [
        {
          "Key": "env",
          "Value": "test"
        }
      ],
      "DataSourceType": "NAS",
      "Uri": "nas://09f****f2.cn-hangzhou/",
      "GmtCreateTime": "2021-01-21T17:12:35.232Z",
      "GmtModifiedTime": "2021-01-21T17:12:35.232Z",
      "DataType": "COMMON",
      "Property": "DIRECTORY",
      "SourceType": "USER",
      "SourceId": "jdnhf***fnrimv",
      "Description": "This is a description of a dataset.",
      "WorkspaceId": "478**",
      "Options": "{\n  \"mountPath\": \"/mnt/data/\"\n}",
      "Accessibility": "PRIVATE",
      "ProviderType": "Ecs",
      "SourceDatasetId": "d-bvfasdfxxxxj8o411",
      "SourceDatasetVersion": "v2",
      "TagTemplateType": "text-classification",
      "LatestVersion": {
        "VersionName": "v1",
        "GmtCreateTime": "2021-01-21T17:12:35.232Z",
        "GmtModifiedTime": "2021-01-21T17:12:35.232Z",
        "Property": "FILE",
        "DataSourceType": "OSS",
        "Uri": "OSS://xxx",
        "Labels": [
          {
            "Key": "env",
            "Value": "test"
          }
        ],
        "Options": "{\n  \"mountPath\": \"/mnt/data/\"\n}",
        "SourceType": "USER",
        "Description": "base model v1",
        "SourceId": "d-65mrsr5fub4u74lej3",
        "DataCount": 10000,
        "DataSize": 10000,
        "MountAccess": "RO",
        "ImportInfo": "{\n    \"region\": \"cn-wulanchabu\",\n    \"fileSystemId\": \"bmcpfs-xxxxxxxxxxx\",\n    \"path\": \"/mnt\",\n    \"mountTarget\": \"cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com\",\n    \"isVpcMount\": true\n}"
      },
      "MountAccess": "RO RW",
      "MountAccessReadWriteRoleIdList": [
        "PAI.AlgoOperator"
      ],
      "ImportInfo": "{\n    \"region\": \"cn-wulanchabu\",\n    \"fileSystemId\": \"bmcpfs-xxxxxxxxxxx\",\n    \"path\": \"/mnt\",\n    \"mountTarget\": \"cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com\",\n    \"isVpcMount\": true\n}",
      "Edition": "BASIC"
    }
  ],
  "TotalCount": 15
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.