ListDatasets - 数据集列表--AI 数据湖服务-火山引擎

文档中心

立即注册

导航

ListDatasets - 数据集列表

最近更新时间：2025.11.28 14:45:00首次发布时间：2025.11.28 14:45:00

数据集列表

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	ListDatasets	要执行的操作，取值：ListDatasets。
Version	String	是	2025-08-15	API的版本，取值：2025-08-15。
SourceTypes	Array of String	否	User	数据集来源列表
Tags	Array of Object	否		标签列表
SortBy	String	否	CreateTime	排序字段
Modals	Array of String	否	Image	数据集模态
Formats	Array of String	否	Image	数据集构建方式
Category	String	否	Common	数据集类别
Nickname	String	否	MyImageDataset	数据集昵称
NextToken	String	否	nextToken	下一次查询起始Id（不包含）或页码（默认为0）
SizeRange	Object	否		数据集样本数量区间
MaxResults	Integer	否	10	单页记录数
SortOrder	String	否	Desc	排序顺序
DatasetName	String	否	my_image_dataset	数据集名称
NumberRange	Object	否		数据集样本数量区间

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Items	Array of Object	--	概要列表
NextToken	String	0	分页查询的下一页token
MaxResults	Integer	10	单次查询可返回的最大记录数
TotalCount	Long	100	总记录数

请求示例

POST /?Action=ListDatasets&Version=2025-08-15 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20251127T104459Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251127/cn-beijing/las/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "SourceTypes": [
    "User"
  ],
  "Tags": [
    {
      "Key": "test_key",
      "Value": "test_value"
    }
  ],
  "SortBy": "CreateTime",
  "Modals": [
    "Image"
  ],
  "Formats": [
    "Image"
  ],
  "Category": "Common",
  "Nickname": "MyImageDataset",
  "NextToken": "nextToken",
  "SizeRange": {
    "Max": 123,
    "Min": 456
  },
  "MaxResults": 10,
  "SortOrder": "Desc",
  "DatasetName": "my_image_dataset",
  "NumberRange": {
    "Max": 123,
    "Min": 456
  }
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2025112718353924113503012443DD6F",
    "Action": "ListDatasets",
    "Version": "2025-08-15",
    "Service": "las",
    "Region": "cn-beijing"
  },
  "Result": {
    "Items": [
      {
        "Size": "1.2 GB",
        "Tags": [
          {
            "Key": "test_key",
            "Value": "test_value"
          }
        ],
        "Format": "Lance",
        "Modals": [
          "Image"
        ],
        "Number": "10,000",
        "Storage": "TOS",
        "Category": "Common",
        "Nickname": "MyImageDataset",
        "OwnerName": "user12345",
        "CreateTime": "2025-01-15T10:30:00Z",
        "SourceType": "User",
        "UpdateTime": "2025-02-20T14:45:00Z",
        "DatasetMode": "Custom",
        "DatasetName": "my_image_dataset"
      }
    ],
    "NextToken": "0",
    "MaxResults": 10,
    "TotalCount": 100
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidRequestParam	Invalid request param {}, cause {}	非法请求参数 {}, 原因 {}
400	InvalidParameter	The specified parameter {} is invalid.	指定的参数 {} 无效。
400	MissingParameter	The required parameter {} is missing.	缺少必需的参数 {}。
500	InternalError	The request has failed due to an unknown error.	由于未知错误，请求失败。