GetDataset API参考与参数说明-人工智能平台 PAI-阿里云

获取数据集。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

paidataset:GetDataset

get

*全部资源

*

无

请求语法

GET /api/v1/datasets/{DatasetId} HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
DatasetId	string	是	数据集 ID。如何获取数据集 ID，详情请参见 ListDatasets 。	d-rbvg5wz****c9ks92

请求参数

名称

类型

必填

描述

示例值

当前API无需请求参数

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。	5A14FA81-DD4E-******-6343FE44B941
DatasetId	string	数据集 ID。	d-rbvg5wz****c9ks92
Name	string	数据集名称。	myName
Description	string	描述。	用于标注的数据。
GmtCreateTime	string	创建时间。	2021-01-30T12:51:33.028Z
GmtModifiedTime	string	更新时间。	2021-01-30T12:51:33.028Z
UserId	string	数据集所属用户 ID。	2485765****023475
OwnerId	string	主账户 ID。	1631044****3440
Property	string	数据集初始版本 v1 的属性。可能值： FILE：文件。 DIRECTORY：文件夹。枚举值： DIRECTORY : DIRECTORY FILE : FILE	DIRECTORY
DataSourceType	string	数据源类型。可能值： OSS：阿里云对象存储（OSS）。 NAS：阿里云文件存储（NAS）。枚举值： NAS : NAS OSS : OSS	NAS
Uri	string	初始版本 v1 的 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/
Labels	array	标签列表。
	Label	为数据集添加的标签。	{"Key": "env", "Value": "test"}
DataType	string	数据集的数据类型，可能值： COMMON：普通。 PIC：图片。 TEXT：文本。 VIDEO：视频。 AUDIO：音频。枚举值： VIDEO : VIDEO COMMON : COMMON TEXT : TEXT PIC : PIC AUDIO : AUDIO	COMMON
SourceType	string	数据来源初始版本 v1 的类型。枚举值： PAI_PUBLIC_DATASET : PAI_PUBLIC_DATASET ITAG : ITAG USER : USER	USER
SourceId	string	初始版本 v1 的数据来源 ID，可能值：当 SourceType 为 USER 时，SourceId 支持自定义。当 SourceType 为 ITAG 时，即 iTAG 模块标注结果生成的数据集时，SourceId 为 ITAG 的任务 ID。当 SourceType 为 PAI_PUBLIC_DATASET 时，即使用 PAI 公共数据集创建的数据集时，SourceId 默认为空。	jdnhf***fnrimv
WorkspaceId	string	数据集所在工作空间 ID。	478**
Options	string	初始版本 v1 的扩展字段，JsonString 类型。当 DLC 使用数据集时，可通过配置 mountPath 字段指定数据集默认挂载路径。	{ "mountPath": "/mnt/data/" }
Accessibility	string	工作空间可见度。可能值： PRIVATE：表示工作空间内自己以及管理员可见。 PUBLIC：为工作空间所有用户可见。枚举值： PUBLIC : PUBLIC PRIVATE : PRIVATE	PRIVATE
ProviderType	string	数据集的数据源来源类型。取值如下： Ecs （默认） Lingjun	Ecs
Provider	string	数据集提供方。返回值为"pai"时表示该数据集为 PAI 平台的公共数据集。	pai
SourceDatasetId	string	iTag 标注集的来源数据集 ID。	d-rcdg3wxxxxxhc5jk87
SourceDatasetVersion	string	标注数据集的来源数据集版本。	v2
TagTemplateType	string	iTag 标注数据集的标注模板	TextClassification
LatestVersion	DatasetVersion	数据集的最新版本。
MountAccess	string	该数据集被挂载时的权限。 RO：只读挂载 RW：读写挂载	RW
MountAccessReadWriteRoleIdList	array	具有该数据集读写权限的工作空间角色名列表，PAI 开头的为基础角色 ID，role-开头的为自定义角色 ID。如果列表中包含了"*"，则表示对所有角色都有读写权限。
	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：基础型。不支持数据集文件元数据管理。 ADVANCED：高级型。仅 OSS 类型支持，每个版本支持最多 100 万个文件元数据管理。	BASIC
IsShared	boolean	是否为共享数据集。枚举值： false : false true : true	false
SharedFrom	DatasetShareRelationship	描述该分享数据集的来源关系。仅 IsShared 为 true 时有效。
SharingConfig	object	当前数据集的分享配置信息。
SharedTo	array	多条分享配置关系。
	DatasetShareRelationship	该数据集被分享的分享配置关系。

示例

正常返回示例

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",
  "Provider": "pai",
  "SourceDatasetId": "d-rcdg3wxxxxxhc5jk87\n",
  "SourceDatasetVersion": "v2",
  "TagTemplateType": "TextClassification",
  "LatestVersion": {
    "VersionName": "v1",
    "GmtCreateTime": "2021-01-21T17:12:35.232Z",
    "GmtModifiedTime": "2021-01-21T17:12:35.232Z",
    "Property": "FILE",
    "DataSourceType": "OSS",
    "Uri": "OSS://xxx",
    "Labels": [
      {
        "Key": "env",
        "Value": "test"
      }
    ],
    "Options": "{\n  \"mountPath\": \"/mnt/data/\"\n}",
    "SourceType": "USER",
    "Description": "base model v1",
    "SourceId": "d-65mrsr5fub4u74lej3",
    "DataCount": 10000,
    "DataSize": 10000,
    "MountAccess": "RO",
    "ImportInfo": "{\n    \"region\": \"cn-wulanchabu\",\n    \"fileSystemId\": \"bmcpfs-xxxxxxxxxxx\",\n    \"path\": \"/mnt\",\n    \"mountTarget\": \"cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com\",\n    \"isVpcMount\": true\n}"
  },
  "MountAccess": "RW",
  "MountAccessReadWriteRoleIdList": [
    "PAI.AlgoOperator"
  ],
  "ImportInfo": "{\n    \"region\": \"cn-wulanchabu\",\n    \"fileSystemId\": \"bmcpfs-xxxxxxxxxxx\",\n    \"path\": \"/mnt\",\n    \"mountTarget\": \"cpfs-xxxxxxxxxxxx-vpc-gacs9f.cn-wulanchabu.cpfs.aliyuncs.com\",\n    \"isVpcMount\": true\n}",
  "Edition": "BASIC",
  "IsShared": false,
  "SharedFrom": {
    "Status": "ACTIVE",
    "SourceTenantId": "148***************115",
    "SourceWorkspaceId": "33**19",
    "TenantId": "153***************249",
    "WorkspaceId": "42**2",
    "AllowedMountAccessLevels": [
      "RO"
    ],
    "IsSecureMode": true,
    "SharedAt": "2025-08-27T12:23:58Z",
    "ExpiresAt": "2026-08-27T12:23:58Z"
  },
  "SharingConfig": {
    "SharedTo": [
      {
        "Status": "ACTIVE",
        "SourceTenantId": "148***************115",
        "SourceWorkspaceId": "33**19",
        "TenantId": "153***************249",
        "WorkspaceId": "42**2",
        "AllowedMountAccessLevels": [
          "RO"
        ],
        "IsSecureMode": true,
        "SharedAt": "2025-08-27T12:23:58Z",
        "ExpiresAt": "2026-08-27T12:23:58Z"
      }
    ]
  }
}

错误码

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

变更历史

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