You need to enable JavaScript to run this app.
Volcano Engine Function as a Service

Volcano Engine Function as a Service

Copy page
Download PDF
Sandbox instances
ResumeSandbox
Copy page
Download PDF
ResumeSandbox
Restore the sandbox instance from the paused state to the running state.​
Request description​
  • Request method: POST​
  • request address: http://open.volcengineapi.com/?Action=ResumeSandbox&Version=2024-06-06​
Debugging​
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
​
Request parameters​
​
Parameter​
Type​
Require​
Sample value​
Description​
Action​
String​
Yes​
ResumeSandbox​
Interface name. The current API name is ResumeSandbox.​
Version​
String​
Yes​
2024-06-06​
Interface version. The current version of the API is 2024-06-06 .​
FunctionId​
String​
Yes​
e8m6****​
ID of the function to which the sandbox instance belongs.​
SandboxId​
String​
Yes​
vefaas-e8m6xarn-p2zamuv2fr-d04b19534o****​
Sandbox instance ID.​
SnapshotId​
String​
No​
snapshot-12****​
Specifies the snapshot ID for restoring the sandbox instance. If this field is not provided, the sandbox instance will be restored from the snapshot generated at the most recent pause by default.​
Timeout​
Integer​
No​
60​
Lifetime of the sandbox instance. The default unit is minutes (minute), and the default value is 60. Switching to seconds (second) is supported via TimeoutUnit.​
  • When the unit is minute: value range is 3 to 2460.​
  • When the unit is second: value range is 60 to 147600.​
TimeoutUnit​
String​
No​
second​
Timeout unit for the sandbox instance's lifetime. Valid values:​
  • minute: Default value, minutes.​
  • second: Seconds.​
Async​
Boolean​
No​
true​
Whether the sandbox instance restoration operation is performed asynchronously. Valid values:​
  • true: The operation will be performed asynchronously.​
  • false: Default value, the operation is performed synchronously.​
​
Sample requests​
​
POST http://open.volcengineapi.com/?Action=ResumeSandbox&Version=2024-06-06 HTTP/1.1​
Content-Type: application/json​
{​
"FunctionId": "e8m6****",​
"SandboxId": "vefaas-e8m6xarn-p2zamuv2fr-d04b19534o****",​
"SnapshotId": "snapshot-12****",​
"Timeout": 60,​
"TimeoutUnit": "second",​
"Async": true​
}
​
Response parameters​
​
Parameter​
Type​
Sample value​
Description​
SandboxId​
String​
vefaas-e8m6xarn-p2zamuv2fr-d04b19534o3****​
ID of the new sandbox instance after restoration.​
​
Sample responses​
​
HTTP/1.1 200 OK​
Content-Type: application/json​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "ResumeSandbox",​
"Version": "2024-06-06",​
"Service": "vefaas",​
"Region": "cn-beijing"​
},​
"Result": {​
"SandboxId": "vefaas-e8m6xarn-p2zamuv2fr-d04b19534o3c0hok****"​
}​
}
​
Error codes​
The current interface temporarily has no independent error code. If the interface calls back abnormally, you can refer to the Public error code to troubleshoot.​
Last updated: 2026.06.23 11:06:12