ListDatasetVersions - Platform For AI - Alibaba Cloud Documentation Center

Retrieves a list of dataset versions.

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:ListDatasetVersions

list

*All Resource

*

None

Request syntax

GET /api/v1/datasets/{DatasetId}/versions HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
DatasetId	string	Yes	The ID of the dataset. For more information, see ListDatasets.	d-rbvg5wz****c9ks92

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	Yes	The page number. The value starts from 1. The default is 1.	1
PageSize	integer	Yes	The number of entries to return on each page. The default value is 10.	10
Order	string	No	The sort order for the paged query. The default value is ASC. Valid values: ASC: Ascending order. DESC: Descending order. Valid values: ASC : ASC DESC : DESC	ASC
LabelKeys	string	No	The label keys used to filter the dataset list. Datasets are returned if their label keys contain the specified strings.	key1,key2
LabelValues	string	No	The label values used to filter the dataset list. Datasets are returned if their label values contain the specified strings.	value1,value2
Properties	string	No	The dataset properties. Valid values: DIRECTORY: Folder. FILE: File. Valid values: DIRECTORY : DIRECTORY FILE : FILE	DIRECTORY
SourceTypes	string	No	The source type. Valid values: PAI-PUBLIC-DATASET: A public dataset from PAI. ITAG: A dataset generated from the annotation results of the iTAG module. USER: A dataset registered by a user. Valid values: PAI_PUBLIC_DATASET : PAI_PUBLIC_DATASET ITAG : ITAG USER : USER	USER
SourceId	string	No	The ID of the data source. If SourceTypes is USER, you can specify a custom ID. If SourceTypes is ITAG, this is the ID of the iTAG annotation task. If SourceTypes is PAI_PUBLIC_DATASET, this parameter is empty by default.	d-a0xbe5n03bhqof46ce
SortBy	string	No	The field to use for sorting in a paged query. The default value is GmtCreateTime. Valid values: GmtCreateTime (default): Creation time. GmtModifiedTime: Modification time. SourceType DataSourceType Property DataSize DataCount Valid values: SourceType : SourceType DataSourceType : DataSourceType DataSize : DataSize DataCount : DataCount Property : Property GmtCreateTime : GmtCreateTime GmtModifiedTime : GmtModifiedTime DatasetId : DatasetId	GmtCreateTime

Response elements

Element	Type	Description	Example
	object	Response body
RequestId	string	Id of the request	0648C5BB-68D0-54D2-92A5-607135B8806B
PageNumber	integer	The current page number.	1
PageSize	integer	The page size.	10
TotalCount	integer	The number of resources that match the filter conditions.	5
DatasetVersions	array	The list of dataset versions.
	DatasetVersion	The dataset version.

Examples

Success response

JSON format

{
  "RequestId": "0648C5BB-68D0-54D2-92A5-607135B8806B",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 5,
  "DatasetVersions": [
    {
      "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}"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.