文档

GetDataset - 获取数据集

更新时间:

获取数据集。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/v1/datasets/{DatasetId}

请求参数

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

数据集 ID。如何获取数据集 ID,详情请参见 ListDatasets

d-rbvg5wz****c9ks92

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

5A14FA81-DD4E-******-6343FE44B941
DatasetIdstring

数据集 ID。

d-rbvg5wz****c9ks92
Namestring

数据集名称。

myName
Descriptionstring

描述。

用于标注的数据。
GmtCreateTimestring

创建时间。

2021-01-30T12:51:33.028Z
GmtModifiedTimestring

更新时间。

2021-01-30T12:51:33.028Z
UserIdstring

数据集所属用户 ID。

2485765****023475
OwnerIdstring

主账户 ID。

1631044****3440
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/
Labelsarray

标签列表。

Label

为数据集添加的标签。

{"Key": "env", "Value": "test"}
DataTypestring

数据类型,可能值:

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

数据来源类型,可能值:

  • 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
WorkspaceIdstring

数据集所在工作空间 ID。

478**
Optionsstring

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

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

工作空间可见度。可能值:

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

数据集的数据源来源类型。取值如下:

  • Ecs (默认)
  • Lingjun
Ecs

示例

正常返回示例

JSON格式

{
  "RequestId": "5A14FA81-DD4E-******-6343FE44B941",
  "DatasetId": "d-rbvg5wz****c9ks92",
  "Name": "myName",
  "Description": "用于标注的数据。",
  "GmtCreateTime": "2021-01-30T12:51:33.028Z",
  "GmtModifiedTime": "2021-01-30T12:51:33.028Z",
  "UserId": "2485765****023475",
  "OwnerId": "1631044****3440",
  "Property": "DIRECTORY",
  "DataSourceType": "NAS",
  "Uri": "nas://09f****f2.cn-hangzhou/",
  "Labels": [
    {
      "Key": "env",
      "Value": "test"
    }
  ],
  "DataType": "COMMON",
  "SourceType": "USER",
  "SourceId": "jdnhf***fnrimv",
  "WorkspaceId": "478**",
  "Options": "{\n  \"mountPath\": \"/mnt/data/\"\n}",
  "Accessibility": "PRIVATE",
  "ProviderType": "Ecs"
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-04-26OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈