GetDataset API Reference & Metadata Overview - 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

GET  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Id	string	Yes	The dataset ID.	dataworks-dataset:3pXXXb8o0ngr07njhps1

Response elements

Element	Type	Description	Example
	object	The schema of the response.
RequestId	string	The ID of the request.	204EAF68-CCE3-5112-8DA0-E7A60F02XXXX
Success	boolean	Indicates whether the request succeeded.	true
Dataset	Dataset	The dataset information.

Examples

Success response

JSON format

{
  "RequestId": "204EAF68-CCE3-5112-8DA0-E7A60F02XXXX",
  "Success": true,
  "Dataset": {
    "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.