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
Function instance
GenWebshellEndpoint
Copy page
Download PDF
GenWebshellEndpoint
Generate function instance Webshell port.​
Request description​
  • Request method: POST​
  • Request address: http://open.volcengineapi.com/?Action=GenWebshellEndpoint&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 parameter​
​
Parameter​
Type​
Required or Not​
Sample value​
Description​
Action​
String​
Yes​
GenWebshellEndpoint​
Interface name. The name of the current API is GenWebshellEndpoint.​
Version​
String​
Yes​
2024-06-06​
Interface version. The current version of the API is 2024-06-06.​
FunctionId​
String​
Yes​
wrw******​
Function ID. You can call the ListFunctions interface to obtain Function ID (Items.Id ).​
InstanceName​
String​
Yes​
wrw******-vd9qztck6t-74b9cf8975-bkd99​
Function instance name. You can call the ListFunctionInstancesinterface to obtain the function instance name.​
warning​
The function instance must be in the Ready state. You can call the ListFunctionInstances interface to obtain the current status of the function instance.​
​
Sample request​
​
POST http://open.volcengineapi.com/?Action=GenWebshellEndpoint&Version=2024-06-06 HTTP/1.1​
Content-Type: application/json​
{​
"FunctionId": "wrw******",​
"InstanceName": "wrw******-vd9qztck6t-74b9cf8975-bkd99"​
}​
​
Response parameter​
​
Parameter​
Type​
Sample value​
Description​
Endpoint​
String​
wss://****.volces.com/ws-****/cn-beijing/webshell?id=wrw****&instance=wrw****-yp9zrxli-prtfgld2t8-mxkbw&ticket=253ac5df-68ae-461f-b65a-****​
Function Webshell end point connection address.​
​
Sample response​
​
HTTP/1.1 200 OK​
Content-Type: application/json​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "GenWebshellEndpoint",​
"Version": "2024-06-06",​
"Service": "vefaas",​
"Region": "cn-beijing"​
},​
"Result": {​
"Endpoint": "wss://****.volces.com/ws-****/cn-beijing/webshell?id=wrw****&instance=wrw****-yp9zrxli-prtfgld2t8-mxkbw&ticket=253ac5df-68ae-461f-b65a-****"​
}​
}​
​
Error code​
The current interface temporarily has no independent error code. If the interface calls back abnormally, you can refer to Public error code to troubleshoot.​
Last updated: 2025.06.30 11:37:45