CreateDataset

更新时间:
复制 MD 格式

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.

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

ProjectId

integer

Yes

The DataWorks workspace ID.

12345

Origin

string

No

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

Valid values:

  • DataWorks :

    DataWorks

DataWorks

Name

string

Yes

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

test_oss_dataset

Comment

string

No

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

this is a comment

DataType

string

No

The data type. Valid values:

  • COMMON: Common (Default)

  • PIC

  • TEXT

  • TABLE

  • VIDEO

  • AUDIO

  • INDEX

Valid values:

  • TABLE :
  • VIDEO :
  • COMMON :
  • TEXT :
  • PIC :
  • INDEX :
  • AUDIO :

COMMON

StorageType

string

Yes

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.

Valid values:

  • NAS :
  • EXTREMENAS :
  • OSS :
  • DLF_LANCE :

OSS

InitVersion

object

Yes

The initial version of the dataset.

Comment

string

No

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

Initial Version

Url

string

Yes

URL

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

ImportInfo

object

No

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.
}

string

No

The storage import configuration information for the dataset.

None

MountPath

string

No

The mount path. It 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 creation was successful.

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.