You need to enable JavaScript to run this app.
文档中心
AI 数据湖服务

AI 数据湖服务

请输入
  • 文档首页
    • AI 数据湖服务API 参考：管控面数据集管理GetDataset - 查看数据集信息
复制全文
下载 pdf
我的收藏
数据集管理
GetDataset - 查看数据集信息
复制全文
下载 pdf
我的收藏
GetDataset - 查看数据集信息
查看数据集信息​
调试​
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 object[] 示例值：---​
数据集标签列表​
Key string 示例值：test_key​
标签键​
​
Value string 示例值：test_value​
标签值​
​
​
Format string 示例值：Lance​
数据集构建方式​
​
Modals string[] 示例值：Image​
数据集模态列表​
​
Number string 示例值：10,000​
数据集样本数量​
​
Catalog object 示例值：---​
数据集catalog信息​
TableName string 示例值：image_table​
表名​
​
SchemaName string 示例值：image_schema​
数据库名​
​
CatalogName string 示例值：las_catalog​
目录名​
​
​
Columns object[] 示例值：---​
数据集列信息​
Name string 示例值：column_name​
字段名称​
​
Type string 示例值：STRING​
字段类型​
​
Comment string 示例值：This is a comment​
字段解释​
​
​
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​
项目名称​
​
​
​
请求示例 1​
​
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"​
}​
​
返回示例 1​
​
{​
"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"​
}​
}​
​
请求示例 2​
​
POST https://open.volcengineapi.com​
{​
"ClientToken": "uuid-xxxxxx",​
"DatasetName": ""​
}​
​
返回示例 2​
​
{​
"Result": {​
"Size": "",​
"Tags": [​
{​
"Key": "",​
"Value": ""​
}​
],​
"Format": "",​
"Modals": [​
""​
],​
"Number": "",​
"Catalog": {​
"Type": "",​
"TableName": "",​
"SchemaName": "",​
"CatalogName": "",​
"DataObjectName": ""​
},​
"Columns": [​
{​
"Name": "",​
"Type": "",​
"Comment": "",​
"ModalType": "",​
"Filterable": false,​
"PrimaryKey": false​
}​
],​
"Privacy": "",​
"Storage": "",​
"Category": "",​
"DataPath": "",​
"Nickname": "",​
"OwnerName": "",​
"UseSample": "",​
"CreateTime": "",​
"SourceType": "",​
"UpdateTime": "",​
"DatasetMode": "",​
"DatasetName": "",​
"Description": "",​
"ProjectName": ""​
},​
"ResponseMetadata": {​
"Action": "GetDataset",​
"Region": "cn-beijing",​
"Service": "las",​
"Version": "2025-08-15",​
"RequestId": "20230604110420****100232280022D31",​
"Deprecated": false​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
InvalidRequestParam​
Invalid request param {}, cause {}​
非法请求参数 {}, 原因 {}​
400​
InvalidParameter​
The specified parameter {} is invalid.​
指定的参数 {} 无效。​
400​
MissingParameter​
The required parameter {} is missing.​
缺少必需的参数 {}。​
400​
IllegalArgument​
非法参数​
非法参数​
403​
DatasetNoPermissionAccess​
You do not have permission to access dataset {{datasetName}}.​
您没有权限访问数据集 {{datasetName}}。​
404​
DatasetNotExist​
Dataset {{datasetName}} does not exist.​
数据集 {{datasetName}} 不存在。​
500​
InternalError​
The request has failed due to an unknown error.​
由于未知错误，请求失败。​
​
​
最近更新时间：2026.10.15 20:22:01
这个页面对您有帮助吗？
有用
有用
无用
无用