ListDatasets - 列出数据集

获取数据集列表,支持通过数据集名称前缀查询列表。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
imm:ListDatasetslist
*Dataset
acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/*

请求参数

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

项目名称,获取方式请参见创建项目

test-project
MaxResultslong

返回数据集的最大个数,取值范围为 0~200。

不设置此参数或者设置为 0 时,则默认值为 100。

1
NextTokenstring

翻页标记。

当文件总数大于设置的 MaxResults 时,用于翻页的 Token。从 NextToken 开始按字典序返回文件信息列表。

说明 在一次查询中首次调用此接口时,将此值设置为空。
12345678:immtest:dataset002
Prefixstring

数据集名称前缀。

dataset

返回参数

名称类型描述示例值
object

响应结构体。

RequestIdstring

请求 ID。

FEEDE356-C928-4A36-951A-6EB5A592****
NextTokenstring

翻页标记。当任务列表总数大于设置的 MaxResults 时,用于翻页的 Token。符合条件的任务列表未全部返回时,此参数才有值。

下一次列出任务列表时将此值作为 NextToken 传入,将后续的任务列表返回。

12345678:immtest:dataset002
Datasetsarray

数据集信息列表。

DatasetsDataset

数据集。

说明
  • ListDatasets 接口不支持文件统计功能,返回的 Dataset 结构体中的 FileCount 和 TotalFileSize 字段值可能不准确,也可能为 0。如需获取准确的文件统计信息,请使用GetDataset-查询数据集信息
  • 示例

    正常返回示例

    JSON格式

    {
      "RequestId": "FEEDE356-C928-4A36-951A-6EB5A592****",
      "NextToken": "12345678:immtest:dataset002",
      "Datasets": [
        {
          "ProjectName": "test-project",
          "DatasetName": "dataset001",
          "Workflow": "defined_workflow",
          "CreateTime": "2021-06-29T14:50:13.011643661+08:00",
          "UpdateTime": "2021-06-29T14:50:13.011643661+08:00",
          "Description": "测试数据集",
          "DatasetMaxBindCount": 10,
          "DatasetMaxFileCount": 100000000,
          "DatasetMaxEntityCount": 10000000000,
          "DatasetMaxRelationCount": 100000000000,
          "DatasetMaxTotalFileSize": 90000000000000000,
          "FileCount": 0,
          "BindCount": 0,
          "TotalFileSize": 0,
          "TemplateId": "DefaultId"
        }
      ]
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2021-06-15新增 OpenAPI查看变更详情