AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 人工智能平台 PAI 开发参考 API参考 PAI-AI WorkSpace API目录 数据集 CreateDataset - 创建数据集

CreateDataset - 创建数据集

更新时间：
产品详情
我的收藏

创建一个数据集。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

paidataset:CreateDataset

create

*全部资源

*

 无 无

请求语法

POST /api/v1/datasets HTTP/1.1

请求参数

名称

类型

必填

描述

示例值
body

object

否

请求体。

Name

string

是

数据集的名称。命名规则如下：

  • 以小写字母、大写字母、数字或中文开头。

  • 可以包含下划线（_）或短划线（-）。

  • 长度为 1~127 个字符。

myName
Property

string

是

数据集的属性。支持以下取值：

  • FILE：文件。

  • DIRECTORY：文件夹。

枚举值：

  • DIRECTORY :

    DIRECTORY

  • FILE :

    FILE

DIRECTORY
DataSourceType

string

是

数据源类型。支持以下取值：

  • OSS：阿里云对象存储（OSS）。

  • NAS：阿里云文件存储（NAS）。

枚举值：

  • NAS :

    NAS

  • OSS :

    OSS

NAS
Uri

string

是

Uri 配置样例如下：

  • 数据源类型为 OSS：oss://bucket.endpoint/object

  • 数据源类型为 NAS： 通用型 NAS 格式为：nas://<nasfisid>.region/subpath/to/dir/； CPFS1.0：nas://<cpfs-fsid>.region/subpath/to/dir/； CPFS2.0：nas://<cpfs-fsid>.region/<protocolserviceid>/。 CPFS1.0 和 CPFS2.0 根据 fsid 的格式来区分：CPFS1.0 格式为 cpfs-<8 位 ASCII 字符>；CPFS2.0 格式为 cpfs-<16 位 ASCII 字符>。

nas://09f****f2.cn-hangzhou/
DataType

string

否

数据集的数据类型，默认为 COMMON。支持以下取值：

  • COMMON：普通。

  • PIC：图片。

  • TEXT：文本。

  • VIDEO：视频。

  • AUDIO：音频。

枚举值：

  • VIDEO :

    VIDEO

  • COMMON :

    COMMON

  • TEXT :

    TEXT

  • PIC :

    PIC

  • AUDIO :

    AUDIO

COMMON
Labels

array

否

标签列表。

Label

否

为数据集添加的标签。

SourceType

string

否

数据来源类型，默认为 USER。

枚举值：

  • PAI_PUBLIC_DATASET :

    PAI_PUBLIC_DATASET

  • ITAG :

    ITAG

  • USER :

    USER

USER
SourceId

string

否

数据来源 ID。

  • 当 SourceType 为 USER 时，SourceId 支持自定义。

  • 当 SourceType 为 ITAG 时，即 iTAG 模块标注结果生成的数据集时，SourceId 为 ITAG 的任务 ID。

  • 当 SourceType 为 PAI_PUBLIC_DATASET 时，即使用 PAI 公共数据集创建的数据集时，SourceId 默认为空。

jdnhf***fnrimv
Description

string

否

对数据集进行自定义描述，以区分不同的数据集。

This is a description of the dataset.
WorkspaceId

string

否

数据集所在工作空间 ID。如何获取工作空间 ID，请参见 ListWorkspaces 。 如果不配置该参数，则会使用默认工作空间；如果默认工作空间不存在，则会报错。

478**
Options

string

否

扩展字段，JsonString 类型。 当 DLC 使用数据集时，可通过配置 mountPath 字段指定数据集默认挂载路径。

{ "mountPath": "/mnt/data/" }
Accessibility

string

否

工作空间可见度。支持以下取值：

  • PRIVATE（默认值）：表示工作空间内自己以及管理员可见。

  • PUBLIC 为：工作空间所有用户可见。

枚举值：

  • PUBLIC :

    PUBLIC

  • PRIVATE :

    PRIVATE

PRIVATE
ProviderType

string

否

数据集的数据源来源类型，支持配置的类型如下：

  • Ecs（默认值）

  • Lingjun

Ecs
Provider

string

否

数据集提供者。不允许设置为 pai。

Github
UserId

string

否

数据集所有者的阿里云账号 ID。工作空间所有者和管理员有权限给指定工作空间成员创建数据集。

2485765****023475
SourceDatasetId

string

否

标注数据集的来源数据集 ID。

d-bvfasdfxxxxj8o411
SourceDatasetVersion

string

否

标注数据集的来源数据集版本。

v2
VersionDescription

string

否

数据集初始版本的描述。

This is a description of the first dataset version.
VersionLabels

array

否

初始版本标签列表。

Label

否

为数据集初始版本添加的标签。

DataSize

integer

否

数据集文件占据空间的大小。单位 Byte 。

10000
DataCount

integer

否

数据集文件数量，单位个。

500
MountAccessReadWriteRoleIdList

array

否

指定该数据集被挂载时具有读写权限的工作空间角色名列表，PAI 开头的为基础角色 ID，role-开头的为自定义角色 ID。如果列表中包含了"*"，则表示对所有角色都有读写权限。

  • 指定角色下的账号： ["PAI.AlgoOperator", "role-hiuwpd01ncrokkgp21"]

  • 全部账号：["*"]

  • 指定为数据集创建者: []

string

否

工作空间角色 ID

PAI.AlgoOperator
ImportInfo

string

否

数据集的存储导入配置信息，支持 OSS/NAS/CPFS 等。

OSS

{
"region": "${region}",//地域 ID
"bucket": "${bucket}",//bucket 名称
"path": "${path}" //文件路径
}














NAS

{
"region": "${region}",//地域 ID
"fileSystemId": "${file_system_id}", //文件系统 ID
"path": "${path}", //文件系统路径
"mountTarget": "${mount_target}" //文件系统挂载点
}

















CPFS

{
"region": "${region}",//地域 ID
"fileSystemId": "${file_system_id}", //文件系统 ID
"protocolServiceId":"${protocol_service_id}", //文件系统协议服务
"exportId": "${export_id}", //文件系统导出目录
"path": "${path}", //文件系统路径
}




















智算 CPFS

{
"region": "${region}",//地域 ID
"fileSystemId": "${file_system_id}", //文件系统 ID
"path": "${path}", //文件系统路径
"mountTarget": "${mount_target}" //文件系统挂载点，智算版特有
"isVpcMount": boolean, //是否为 vpc 挂载点, 智算版特有
}

{ "region": "cn-wulanchabu", "fileSystemId": "bmcpfs-xxxxxxxxxxx", "path": "/mnt", "mountTarget": "cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com", "isVpcMount": true }
Edition

string

否

数据集类型。默认为 BASIC，支持以下取值：

  • BASIC：基础型。不支持数据集文件元数据管理。

  • ADVANCED：高级型。仅 OSS 类型支持，每个版本支持最多 100 万个文件元数据管理。

ADVANCED

返回参数

名称

类型

描述

示例值

object

返回体。

RequestId

string

请求 ID。

B2C51F93-1C07-5477-9705-5FDB****F19F
DatasetId

string

数据集 ID。

d-rbvg5*****jhc9ks92

示例

正常返回示例

JSON格式

{
  "RequestId": "B2C51F93-1C07-5477-9705-5FDB****F19F",
  "DatasetId": "d-rbvg5*****jhc9ks92"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。

上一篇：CreateDatasetJob - 创建数据集任务下一篇：GetDataset - 获取数据集