CreateDataset - 创建数据集

创建一个数据集。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
paidataset:CreateDatasetcreate
*全部资源
*

请求语法

POST /api/v1/datasets HTTP/1.1

请求参数

名称类型必填描述示例值
bodyobject

请求体。

Namestring

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

  • 以小写字母、大写字母、数字或中文开头。
  • 可以包含下划线(_)或短划线(-)。
  • 长度为 1~127 个字符。
myName
Propertystring

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

  • FILE:文件。
  • DIRECTORY:文件夹。
DIRECTORY
DataSourceTypestring

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

  • OSS:阿里云对象存储(OSS)。
  • NAS:阿里云文件存储(NAS)。
NAS
Uristring

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/
DataTypestring

数据集类型,默认为 COMMON。支持以下取值:

  • COMMON:普通。
  • PIC:图片。
  • TEXT:文本。
  • VIDEO:视频。
  • AUDIO:音频。
COMMON
Labelsarray

标签列表。

Label

为数据集添加的标签。

SourceTypestring

数据来源类型,默认为 USER。支持以下取值:

  • PAI-PUBLIC-DATASET:PAI 公共数据集。
  • ITAG:iTAG 模块标注结果生成的数据集。
  • USER:用户注册的数据集。
枚举值:
  • PAI_PUBLIC_DATASETPAI_PUBLIC_DATASET
  • ITAGITAG
  • USERUSER
USER
SourceIdstring

数据来源 ID。

  • 当 SourceType 为 USER 时,SourceId 支持自定义。
  • 当 SourceType 为 ITAG 时,即 iTAG 模块标注结果生成的数据集时,SourceId 为 ITAG 的任务 ID。
  • 当 SourceType 为 PAI_PUBLIC_DATASET 时,即使用 PAI 公共数据集创建的数据集时,SourceId 默认为空。
jdnhf***fnrimv
Descriptionstring

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

用于标注的数据。
WorkspaceIdstring

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

478**
Optionsstring

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

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

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

  • PRIVATE(默认值):表示工作空间内自己以及管理员可见。
  • PUBLIC 为:工作空间所有用户可见。
PRIVATE
ProviderTypestring

数据集的数据源来源类型,支持配置的类型如下:

  • Ecs(默认值)
  • Lingjun
Ecs
Providerstring

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

Github
UserIdstring

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

2485765****023475
SourceDatasetIdstring

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

d-bvfasdfxxxxj8o411
SourceDatasetVersionstring

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

v2
VersionDescriptionstring

数据集初始版本的描述。

初始版本。
VersionLabelsarray

初始版本标签列表。

Label

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

DataSizelong

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

10000
DataCountlong

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

500

返回参数

名称类型描述示例值
object

返回体。

RequestIdstring

请求 ID。

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

数据集 ID。

d-rbvg5*****jhc9ks92

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
2024-10-18API 内部配置变更,不影响调用查看变更详情
2024-07-09API 内部配置变更,不影响调用查看变更详情
2024-06-20API 内部配置变更,不影响调用查看变更详情
2024-02-27API 内部配置变更,不影响调用查看变更详情
2023-04-26API 内部配置变更,不影响调用查看变更详情