All Products
Search
Document Center

DataWorks:CreateDataset

Last Updated:Jan 12, 2026

Creates a dataset. This operation is supported only in workspaces that the user has joined. Currently, only DataWorks datasets are supported. The maximum number of datasets allowed per tenant is 2,000.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dataworks:CreateDatasetcreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ProjectIdlongYes

The DataWorks workspace ID.

12345
OriginstringNo

The source of the dataset. Currently, only DataWorks is supported.

DataWorks
NamestringYes

The name of the dataset. It cannot be an empty string and must not exceed 128 characters in length.

test_oss_dataset
CommentstringNo

The description of the dataset. It must not exceed 1,024 characters in length.

this is a comment
DataTypestringNo

The data type. Valid values:

  • COMMON: Common (Default)
  • PIC
  • TEXT
  • TABLE
  • VIDEO
  • AUDIO
  • INDEX
COMMON
StorageTypestringYes

The storage type. Currently supported values:

  • OSS
  • NAS: General-purpose NAS file systems
  • EXTREMENAS: Extreme NAS file systems
  • DLF_LANCE: Data Lake Formation

Valid values:

  • NAS: General-purpose NAS file systems
  • MAXCOMPUTE: MaxCompute table
  • CPFS: Cloud Parallel File Storage
  • BMCPFS: CPFS for Lingjun
  • EXTREMENAS: Extreme NAS file systems
  • OSS: Object Storage Service
  • DLF_LANCE: Data Lake Formation.
OSS
InitVersionobjectYes

The initial version of the dataset.

CommentstringNo

The description. It must not exceed 1,024 characters in length.

Initial Version
UrlstringYes

URL

oss://test-oss-bucket/test_dir/
ImportInfoobjectNo

The storage import configuration for the dataset. The required configuration information varies by storage type.

NAS

For valid values, refer to the response of the file storage API DescribeFileSystems.

{
"fileSystemId": "3b6XXX89c9", // The file system ID.
"fileSystemStorageType":  "Performance" // The storage specification of the file system.
"vpcId": "vpc-uf66oxxxrqge1t2gson7s" // The VPC ID of the mount point.
}
stringNo

The storage import configuration information for the dataset.

None
MountPathstringNo

The mount path. It must start with /mnt/. Default value: /mnt/data.

/mnt/data

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

Id of the request

99EBE7CF-69C0-5089-BE3E-79563C31XXXX
Successboolean

Indicates whether the creation was successful.

true
Idstring

ID

dataworks-dataset:3pXXXb8o0ngr07njhps1

Examples

Sample success responses

JSONformat

{
  "RequestId": "99EBE7CF-69C0-5089-BE3E-79563C31XXXX",
  "Success": true,
  "Id": "dataworks-dataset:3pXXXb8o0ngr07njhps1"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2025-12-04Add OperationView Change Details