Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

The table below lists only the unique request parameters for this API and some common parameters. For more information, see common parameters.

Parameter	Type	Required	Example value	Description
Action	String	Yes	GetDataset	The operation to perform. Value: GetDataset.
Version	String	Yes	2025-08-15	API version. Value: 2025-08-15.
DatasetName	String	Yes	example_dataset_2025	Dataset name

Response parameters

The table below lists only the unique response parameters for this API. For more information, see response structure.

Parameter	Type	Example value	Description
Size	String	1.2 GB	Dataset size
Tags	Array of Object		Dataset tag list
Format	String	Lance	Dataset construction method
Modals	Array of String	Image	Dataset modality list
Number	String	10,000	Number of dataset samples
Catalog	Object		Dataset catalog information
Columns	Array of Object		Dataset column information
Storage	String	TOS	Dataset storage type
Category	String	Common	Dataset type
DataPath	String	tos://my-bucket/image-dataset/	Dataset data path
Nickname	String	MyImageDataset	Dataset nickname
OwnerName	String	user12345	Creator
UseSample	String	SELECT * FROM dataset WHERE label = 'cat' LIMIT 10;	Dataset usage example
CreateTime	String	2025-01-15T10:30:00Z	Creation time
SourceType	String	User	Dataset source type
UpdateTime	String	2025-02-20T14:45:00Z	Update time
DatasetMode	String	Custom	Dataset source type. Custom: user-defined; Example: sample file
DatasetName	String	my_image_dataset	Dataset name
Description	String	A dataset containing 10,000 images for classification	Dataset description
ProjectName	String	my_project	Project name

Request example

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" 
}

Response example

{ 
  "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" 
  } 
}

Error codes

The table below lists the error codes related to the business logic of this API. For common error codes, see the common error codes documentation.

Status code	Error code	Error message	Description
400	InvalidRequestParam	Invalid request param {}, cause {}	Invalid request parameter {}, reason {}
400	InvalidParameter	The specified parameter {} is invalid.	The specified parameter {} is invalid.
400	MissingParameter	The required parameter {} is missing.	Missing required parameter {}.
500	InternalError	The request has failed due to an unknown error.	The request failed due to an unknown error.

Last updated: 2026.05.18 20:10:09

Lake AI Service

Debug #

Request parameters #

Response parameters #

Request example #