DocsICP FilingConsole
Documentation

CreateDataset

Updated at:
Copy as MD
Product
My Favorites

Creates a dataset. You can create a dataset only in a workspace that you have joined. Only DataWorks datasets are supported. The maximum number of datasets per tenant is 2000.

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

dataworks:CreateDataset

create

*All Resource

*

 None None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example
ProjectId

integer

Yes

The ID of the DataWorks workspace.

12345
Origin

string

No

The origin of the dataset. Only DataWorks is supported.

Valid values:

  • DataWorks :

    DataWorks

DataWorks
Name

string

Yes

The name of the dataset. The value must be a non-empty string that is up to 128 characters in length.

test_oss_dataset
Comment

string

No

The description of the dataset. The value can be up to 1024 characters in length.

this is a comment
DataType

string

No

The data type. Valid values:

  • COMMON: general-purpose (default).

  • PIC: image.

  • TEXT: text.

  • TABLE: table.

  • VIDEO: video.

  • AUDIO: audio.

  • INDEX: index.

Valid values:

  • TABLE :

    table.

  • VIDEO :

    video.

  • COMMON :

    general-purpose.

  • TEXT :

    text.

  • PIC :

    image.

  • INDEX :

    index.

  • AUDIO :

    audio.

COMMON
StorageType

string

Yes

The storage type. Valid values:

  • OSS: Object Storage Service.

  • NAS: general-purpose NAS file storage.

  • EXTREMENAS: extreme NAS file storage.

  • DLF_LANCE: Data Lake Formation.

Valid values:

  • NAS :

    general-purpose NAS file storage.

  • EXTREMENAS :

    extreme NAS file storage.

  • OSS :

    Object Storage Service.

  • DLF_LANCE :

    Data Lake Formation.

OSS
InitVersion

object

Yes

The initial version of the dataset.

Comment

string

No

The description. The value can be up to 1024 characters in length.

Initial Version
Url

string

Yes

The URL.

oss://test-oss-bucket/test_dir/
ImportInfo

object

No

The storage import configuration of the dataset. The required configuration varies depending on the storage type.

NAS

The values can be obtained from the response of the File Storage NAS API DescribeFileSystems operation. 
{
  "fileSystemId": "3b6XXX89c9", // File system ID
  "fileSystemStorageType": "Performance", // Storage specification of the file system
  "vpcId": "vpc-uf66oxxxrqge1t2gson7s" // VPC ID of the mount target
}

string

No

The storage import configuration of the dataset.

None
MountPath

string

No

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

/mnt/data

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

Id of the request

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

boolean

Indicates whether the dataset is created.

true
Id

string

ID

dataworks-dataset:3pXXXb8o0ngr07njhps1

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.