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 following table lists only the request parameters specific to this API and some common parameters. For more information, see Common parameters.

Parameter	Type	Required	Example	Description
Action	String	Yes	ListDatasets	The operation to perform. Value: ListDatasets.
Version	String	Yes	2025-08-15	API version. Value: 2025-08-15.
SourceTypes	Array of String	No	User	List of dataset sources
Permissions	Array of String	No	Manageable	Permissions. Values: Manageable (manageable), Readable (readable)
Tags	Array of Object	No		List of tags
SortBy	String	No	CreateTime	Sort field
Modals	Array of String	No	Image	Dataset modality
Formats	Array of String	No	Image	Dataset construction method
Category	String	No	Common	Dataset category
Nickname	String	No	MyImageDataset	Dataset nickname
NextToken	String	No	nextToken	The starting ID (exclusive) or page number for the next query (default is 0)
SizeRange	Object	No		Dataset sample quantity range
MaxResults	Integer	No	10	Number of records per page
SortOrder	String	No	Desc	Sort order
DatasetName	String	No	my_image_dataset	Dataset name
NumberRange	Object	No		Dataset sample quantity range

Response parameters

The following table lists only the response parameters specific to this API. For more information, see Response structure.

Parameter	Type	Example	Description
Items	Array of Object	--	Summary list
NextToken	String	0	Token for the next page in paginated queries
MaxResults	Integer	10	Maximum number of records returned per query
TotalCount	Long	100	Total number of records

Request example

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

Response example

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

Error codes

The following table 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 {}, cause {}
400	InvalidParameter	The specified parameter {} is invalid.	The specified parameter {} is invalid.
400	MissingParameter	The required parameter {} is missing.	The required parameter {} is missing.
500	InternalError	The request has failed due to an unknown error.	The request failed due to an unknown error.

Last updated: 2026.08.03 10:44:00

Lake AI Service

Debug #

Request parameters #

Response parameters #

Request example #