Docs

Volcano Engine Function as a Service

API reference

API list

Volcano Engine Function as a Service (veFaaS) provides the following API.

Cloud sandboxes

Sandbox instances

API	Description
CreateSandbox	Create sandbox instances.
ListSandboxes	Obtain an instance list of sandbox applications.
DescribeSandbox	Query the details of sandbox instances
SetSandboxTimeout	Modify sandbox instance lifetime.
KillSandbox	Delete a sandbox instance.
ResumeSandbox	Resume sandbox instance from paused state to running state.
PauseSandbox	Pause sandbox instance.

Sandbox images

API	Description
PrecacheSandboxImages	Preheat custom images in batch.
GetSandboxImagePrecacheTicket	Obtain details of an image preheating ticket.
ListSandboxImages	Obtain information of preheated images in batch.
DeleteSandboxImage	Delete the preheated image.
CreateCustomImageRegistry	Create custom CR.
GetCustomImageRegistry	Obtain custom CR information.
ListCustomImageRegistries	Batch retrieve custom Container Registry (CR) information.
UpdateCustomImageRegistry	Update custom CR.
DeleteCustomImageRegistry	Delete custom CR.

Functions

API	Description
CreateFunction	Create a function, including function configurations and function code.
GetFunction	Obtain function details, including function configurations and code.
UpdateFunction	Update a function, including function configurations and code.
DeleteFunction	Delete function.
ListFunctions	Obtain function information in batch. Contains only the basic configuration of a function, but not the function code.
CopyFunction	Copy function.
Release	Release a function.
GetReleaseStatus	Query the release status of a function.
UpdateRelease	Update function release (update release traffic proportion).
AbortRelease	Cancel function release.
GetRevision	Obtain the version information of a function, including the configuration and code information of the current version.
ListRevisions	Obtain the version configurations of functions in batch.
ListReleaseRecords	Query the release history of functions.
GetImageSyncStatus	View the function image status, including synchronization and caching status of images.

Function instances

API	Description
ListFunctionInstances	Query the list of function instances.
GetFunctionInstanceLogs	Query the logs of function instances.
GenWebshellEndpoint	Generate a Webshell port for a function instance.

Trigger

API	Description
ListTriggers	Obtain all triggers in bulk.
GetRocketMQTrigger	Query RocketMQ Trigger details.

Timer triggers

API	Description
CreateTimer	Call the CreateTimer interface to create a Timer Trigger in the specified function.
GetTimer	Call the GetTimer interface to obtain Timer trigger details.
UpdateTimer	Call the UpdateTimer interface to update the configuration of Timer trigger.
DeleteTimer	Call the DeleteTimer interface and delete the Timer Trigger.

Kafka triggers

API	Description
CreateKafkaTrigger	Create Kafka trigger.
UpdateKafkaTrigger	Update the specified Kafka Trigger.
GetKafkaTrigger	Obtain detailed information of a Kafka trigger.
DeleteKafkaTrigger	Delete a specified Kafka trigger.

Asynchronous tasks

API	Description
TerminateAsyncTask	Terminate asynchronous tasks.
ListAsyncTasks	Obtain the list of asynchronous tasks.

Dependency installation tasks

API	Description
CreateDependencyInstallTask	Create a dependency installation task.
GetDependencyInstallTaskStatus	View the status of dependency installation tasks.
Terminating dependency installation tasks	Terminate the dependency installation task.
GetDependencyInstallTaskLogDownloadURI	View the log download link of dependency installation tasks.

Last updated: 2026.10.16 11:27:55