Query Dataset Versions via ListDatasetVersions API - DataWorks - Alibaba Cloud - DataWorks

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
DatasetId	string	Yes	The dataset ID.	dataworks-dataset:3pXXXb8o0ngr07njhps1
CreatorId	string	No	The creator ID.	12103XXX46492139
SortBy	string	No	The sort field. Default: VersionNumber. Valid values: ModifyTime: Modification time. CreateTime: Creation time. VersionNumber: Version number. Valid values: ModifyTime : CreateTime : VersionNumber :	CreateTime
Order	string	No	The sort order. Default: Desc. Valid values: Asc: Ascending. Desc: Descending. Valid values: Asc : Desc :	Desc
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	E25887B7-579C-54A5-9C4F-83A0DE367XXX
Success	boolean	Indicates whether the request was successful.	true
PagingInfo	object	The pagination information.
TotalCount	integer	The total number of entries.	100
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
DatasetVersions	array	The dataset version list.
	DatasetVersion	The dataset version.

Examples

Success response

JSON format

{
  "RequestId": "E25887B7-579C-54A5-9C4F-83A0DE367XXX",
  "Success": true,
  "PagingInfo": {
    "TotalCount": 100,
    "PageNumber": 1,
    "PageSize": 10,
    "DatasetVersions": [
      {
        "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"
        }
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.