ListDatasets-阿里云帮助中心

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 for the paged query. Starts at 1. The default is 1.	1
PageSize	integer	No	The number of datasets to return per page. The default is 10.	10
Order	string	No	The sort order for the results, based on the `SortBy` parameter. The default is `ASC`. `ASC`: ascending order. `DESC`: descending order. Valid values: ASC : ASC DESC : DESC	ASC
Name	string	No	The dataset name. Fuzzy search is supported.	myName
Properties	string	No	The dataset properties. To specify multiple properties, separate them with commas (,). Valid values: `DIRECTORY`: A folder. `FILE`: A file. Valid values: DIRECTORY : DIRECTORY FILE : FILE	FILE
DataSourceTypes	string	No	The data source type. To specify multiple types, separate them with commas (,). Valid values: `NAS`: The data source is NAS. `OSS`: The data source is OSS. Valid values: NAS : NAS OSS : OSS	OSS
DataTypes	string	No	The data type of the dataset. To specify multiple data types, separate them 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 source ID. The value of this parameter varies based on the `SourceTypes` value: If `SourceTypes` is `USER`, you can specify a custom value for `SourceId`. If `SourceTypes` is `ITAG`, `SourceId` is the ID of the iTAG task. If `SourceTypes` is `PAI_PUBLIC_DATASET`, this parameter is empty by default.	d-rbvg5wzljzjhc9ks92
SourceTypes	string	No	The source type. To specify multiple types, separate them with commas (,). Valid values: PAI_PUBLIC_DATASET : PAI_PUBLIC_DATASET ITAG : ITAG USER : USER	USER,ITAG
WorkspaceId	string	No	The ID of the workspace that contains the dataset. For information about how to obtain the workspace ID, see ListWorkspaces. If this parameter is not specified, the default workspace is used. An error is returned if the default workspace does not exist.	324**
Label	string	No	A label used to filter datasets. The operation returns datasets whose label key or value contains the specified string.	test
Provider	string	No	The dataset provider. Set this parameter to `pai` to query public datasets on the PAI platform.	pai
SourceDatasetId	string	No	The source dataset ID for an iTAG annotation set.	d-rcdg3wxxxxxhc5jk87
SortBy	string	No	The sort field. Valid values: DataSourceType : DataSourceType DataType : DataType GmtCreateTime : GmtCreateTime GmtModifiedTime : GmtModifiedTime	GmtCreateTime
ShareScope	string	No	A filter for shared datasets. `TO_ME`: Returns only datasets shared with you. `BY_ME`: Returns only datasets that you have shared with others and displays details of the sharing configuration. If this parameter is omitted or empty, the operation returns all datasets in the current workspace, including those shared with you. Valid values: TO_ME : TO_ME BY_ME : BY_ME	BY_ME
Edition	string	No	The dataset edition. Valid values: `BASIC`: Basic edition. Does not support file metadata management. `ADVANCED`: Advanced edition. This edition is supported only for OSS datasets. Each version can manage metadata for up to 1 million files. `LOGICAL`: Logical edition. This edition is supported only for OSS datasets and is suitable for most use cases. Each version can manage metadata for up to 1 million files. You must use an SDK with this edition. Valid values: LOGICAL : LOGICAL BASIC : BASIC ADVANCED : ADVANCED	BASIC
Accessibility	string	No	Specifies the dataset's visibility. `PUBLIC`: The dataset is publicly accessible. `PRIVATE`: The dataset is privately accessible. Valid values: PUBLIC : PUBLIC PRIVATE : PRIVATE	PRIVATE
DatasetIds	string	No	A comma-separated list of dataset IDs.	d-rcdg3wxxxxxhc5jk87

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 count of datasets.	15

Examples

Success response

JSON format

{
  "RequestId": "5A14FA81-DD4E-******-6343FE44B941",
  "Datasets": [
    {
      "DatasetId": "d-c0h44g3****j8o4348",
      "UserId": "2485765****023475",
      "OwnerId": "1631044****3440",
      "Name": "myName",
      "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",
      "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",
      "IsShared": false,
      "SharedFrom": {
        "Status": "ACTIVE",
        "SourceTenantId": "148***************115",
        "SourceWorkspaceId": "33**19",
        "TenantId": "153***************249",
        "WorkspaceId": "42**2",
        "IsSecureMode": true,
        "SharedAt": "2025-08-27T12:23:58Z",
        "ExpiresAt": "2026-08-27T12:23:58Z",
        "AllowedMountAccessLevels": [
          "RO"
        ],
        "Extra": "{\"AllowExportModel\":false,\"AllowAccessDLCWebTerminal\":false,\"AllowAccessDLCFullLog\":false}"
      },
      "SharingConfig": {
        "SharedTo": [
          {
            "Status": "ACTIVE",
            "SourceTenantId": "148***************115",
            "SourceWorkspaceId": "33**19",
            "TenantId": "153***************249",
            "WorkspaceId": "42**2",
            "IsSecureMode": true,
            "SharedAt": "2025-08-27T12:23:58Z",
            "ExpiresAt": "2026-08-27T12:23:58Z",
            "AllowedMountAccessLevels": [
              "RO"
            ],
            "Extra": "{\"AllowExportModel\":false,\"AllowAccessDLCWebTerminal\":false,\"AllowAccessDLCFullLog\":false}"
          }
        ]
      },
      "Labels": [
        {
          "Key": "env",
          "Value": "test"
        }
      ],
      "MountAccessReadWriteRoleIdList": [
        "PAI.AlgoOperator"
      ],
      "AccessibleRoleIdList": [
        ""
      ]
    }
  ],
  "TotalCount": 15
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.