GenWebshellEndpoint--函数服务-火山引擎

文档中心

立即注册

导航

GenWebshellEndpoint

最近更新时间：2025.03.14 16:37:23首次发布时间：2025.03.14 16:37:23

生成函数实例 Webshell 端口。

请求说明

请求方式：POST
请求地址：http://open.volcengineapi.com/?Action=GenWebshellEndpoint&Version=2024-06-06

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	GenWebshellEndpoint	接口名称。当前 API 的名称为 `GenWebshellEndpoint`。
Version	String	是	2024-06-06	接口版本。当前 API 的版本为 `2024-06-06`。
FunctionId	String	是	wrw******	函数 ID。可以调用 ListFunctions 接口，获取函数 ID（`Items.Id`）。
InstanceName	String	是	wrw******-vd9qztck6t-74b9cf8975-bkd99	函数实例名称。可以调用 ListFunctionInstances 接口，获取函数实例名称。注意函数实例必须处于`Ready`状态。可调用 ListFunctionInstances 接口获取函数实例当前的状态。

请求示例

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

返回参数

参数	类型	示例值	描述
Endpoint	String	wss://**.volces.com/ws-/cn-beijing/webshell?id=wrw&instance=wrw-yp9zrxli-prtfgld2t8-mxkbw&ticket=253ac5df-68ae-461f-b65a-**	函数 Webshell 终端连接地址。

返回示例

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

错误码

当前接口暂无独立错误码，若接口调用返回异常，可参考公共错误码进行故障排查。