查询数据集列表,当前支持DataWorks数据集与PAI数据集。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dataworks:ListDatasets | list | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ProjectId | long | 否 | DataWorks 工作空间 ID | 251363 |
| Origin | string | 否 | 数据集来源,取值有
| DataWorks |
| Name | string | 否 | 数据集名称,支持模糊搜索 | test_dataset |
| DataTypeList | array | 否 | 数据类型,可多选,当前支持
| |
| string | 否 | 数据类型 枚举值:
| COMMON | |
| StorageTypeList | array | 否 | 存储类型,可多选,当前支持
| |
| string | 否 | 存储类型 | NAS | |
| CreatorId | string | 否 | 创建者 ID | 12103XXX46492139 |
| SortBy | string | 否 | 排序字段,默认为 CreateTime(创建时间) 枚举值:
| CreateTime |
| Order | string | 否 | 排序方向,默认为 Desc(降序) 枚举值:
| Asc |
| PageNumber | integer | 否 | 分页页码,默认为 1 | 1 |
| PageSize | integer | 否 | 分页大小,默认为 10,最大 100 | 10 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "6A6CBE87-9F91-1323-B680-E7A7065XXXXX\n",
"Success": true,
"PagingInfo": {
"TotalCount": 100,
"PageNumber": 1,
"PageSize": 10,
"Datasets": [
{
"Id": "dataworks-dataset:1gxxxqjx155usz3hrv",
"Name": "test_dataset",
"Comment": "测试数据集",
"ProjectId": 123456,
"Origin": "DataWorks",
"DataType": "COMMON",
"StorageType": "OSS",
"CreatorId": 210484359,
"Readme": "## introduction",
"LatestVersion": {
"Id": "dataworks-datasetVersion:0gfxxxjx155usz3hrv:1",
"DatasetId": "dataworks-datasetVersion:0gfxxxjx155usz3hrv",
"Comment": "初始版本",
"CreatorId": "17815XXX61016173",
"VersionNumber": 1,
"StorageType": "OSS",
"Url": "oss://test-oss-bucket/test_dir/",
"MountPath": "/mnt/data",
"CreateTime": 1736756055000,
"ModifyTime": 1736756055000,
"Labels": [
{
"Key": "key1",
"Value": "value1"
}
],
"ImportInfo": {
"key": "None"
}
},
"CreateTime": 1736756055000,
"ModifyTime": 1736756055000,
"Labels": [
{
"Key": "key1",
"Value": "value1"
}
]
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2025-12-04 | 新增 OpenAPI | 查看变更详情 |
