调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	GetDataset	要执行的操作，取值：GetDataset。
Version	String	是	2025-08-15	API的版本，取值：2025-08-15。
DatasetName	String	是	example_dataset_2025	数据集名称

返回参数

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

参数	类型	示例值	描述
Size	String	1.2 GB	数据集大小
Tags	Array of Object		数据集标签列表
Format	String	Lance	数据集构建方式
Modals	Array of String	Image	数据集模态列表
Number	String	10,000	数据集样本数量
Catalog	Object		数据集catalog信息
Columns	Array of Object		数据集列信息
Storage	String	TOS	数据集存储类型
Category	String	Common	数据集类型
DataPath	String	tos://my-bucket/image-dataset/	数据集数据路径
Nickname	String	MyImageDataset	数据集昵称
OwnerName	String	user12345	创建人
UseSample	String	SELECT * FROM dataset WHERE label = 'cat' LIMIT 10;	数据集使用样例
CreateTime	String	2025-01-15T10:30:00Z	创建时间
SourceType	String	User	数据集来源类型
UpdateTime	String	2025-02-20T14:45:00Z	更新时间
DatasetMode	String	Custom	数据集源类型，Custom：用户自定义，Example：示例文件
DatasetName	String	my_image_dataset	数据集名称
Description	String	A dataset containing 10,000 images for classification	数据集描述
ProjectName	String	my_project	项目名称

请求示例

POST /?Action=GetDataset&Version=2025-08-15 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20251127T103638Z
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

{
  "DatasetName": "example_dataset_2025"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20251128142847209197178100D53658",
    "Action": "GetDataset",
    "Version": "2025-08-15",
    "Service": "las",
    "Region": "cn-beijing"
  },
  "Result": {
    "Size": "1.2 GB",
    "Tags": [
      {
        "Key": "test_key",
        "Value": "test_value"
      }
    ],
    "Format": "Lance",
    "Modals": [
      "Image"
    ],
    "Number": "10,000",
    "Catalog": {
      "TableName": "image_table",
      "SchemaName": "image_schema",
      "CatalogName": "las_catalog"
    },
    "Columns": [
      {
        "Name": "column_name",
        "Type": "STRING",
        "Comment": "This is a comment"
      }
    ],
    "Storage": "TOS",
    "Category": "Common",
    "DataPath": "tos://my-bucket/image-dataset/",
    "Nickname": "MyImageDataset",
    "OwnerName": "user12345",
    "UseSample": "SELECT * FROM dataset WHERE label = 'cat' LIMIT 10;",
    "CreateTime": "2025-01-15T10:30:00Z",
    "SourceType": "User",
    "UpdateTime": "2025-02-20T14:45:00Z",
    "DatasetMode": "Custom",
    "DatasetName": "my_image_dataset",
    "Description": "A dataset containing 10,000 images for classification",
    "ProjectName": "my_project"
  }
}

错误码

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

状态码	错误码	错误信息	说明
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.	由于未知错误，请求失败。

最近更新时间：2025.12.19 11:47:22

这个页面对您有帮助吗？

有用

无用

AI 数据湖服务

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

调试

请求参数

返回参数

请求示例

返回示例

错误码