调用GetWebshellToken获取Web Shell远程登录Token-Serverless 应用引擎-阿里云-Serverless 应用引擎(SAE)-阿里云帮助中心

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

sae:GetWebshellToken

get

*全部资源

*

无

请求语法

GET /pop/v1/sam/instance/webshellToken HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
AppId	string	是	应用 ID。	017f39b8-dfa4-4e16-a84b-1dcee4b1****
PodName	string	是	Pod 名称。	hello-podsdfsdfsdfsdf
ContainerName	string	否	容器名称。注意事项：如果指定了该参数，云助手将在实例的指定容器内执行脚本。如果指定了该参数，仅支持在云助手 Agent 版本不低于 2.2.3.344 的 Linux 实例内运行。查看云助手 Agent 版本的具体操作，请参见安装云助手 Agent 。升级云助手 Agent 版本的具体操作，请参见升级或禁止升级云助手 Agent。如果指定了该参数，本接口中已指定的`Username`参数和 CreateCommand 中指定的`WorkingDir`参数将不会生效。仅支持通过容器默认用户在容器的默认工作目录下执行命令。更多信息，请参见使用云助手在容器内执行命令。如果指定了该参数，在 Linux 容器中只支持执行 Shell 脚本，不支持在脚本开头使用类似`#!/usr/bin/python`命令的形式指定脚本内容的解释器。更多信息，请参见使用云助手在容器内执行命令。	ad-helper

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	调用结果的附加信息。取值说明如下：请求正常，返回 success。请求异常，返回具体异常错误码。	success
TraceId	string	调用链 ID。	0a98a02315955564772843261e****
Data	object	返回结果。
Token	string	Token 信息。	zWWpvRj_5pzof4hfo7-hGynM8oGMmO_7
HttpUrl	string	Webshell 页面地址	HttpUrl : "https://saenext.console.aliyun.com/cn-shenzhen/app-list/app1/micro-app/shell/pod1?tokenId=xxx
WebSocketUrl	string	Websocket 地址	wss://sae-webshell.console.aliyun.com/websocket/eamWebshell?tokenId=xxx&region=cn-shenzhen
ErrorCode	string	错误码。取值说明如下：请求成功：不返回 ErrorCode 字段。请求失败：返回 ErrorCode 字段。具体信息，请参见本文的错误码目录。
Code	string	HTTP 状态码。取值说明如下： 2xx：成功。 3xx：重定向。 4xx：请求错误。 5xx：服务器错误。	200
Success	boolean	是否成功。	true

示例

正常返回示例

JSON格式

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "Token": "zWWpvRj_5pzof4hfo7-hGynM8oGMmO_7",
    "HttpUrl": "HttpUrl :  \"https://saenext.console.aliyun.com/cn-shenzhen/app-list/app1/micro-app/shell/pod1?tokenId=xxx",
    "WebSocketUrl": "wss://sae-webshell.console.aliyun.com/websocket/eamWebshell?tokenId=xxx&region=cn-shenzhen"
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidApplication.NotFound	The current application does not exist.	找不到当前应用。
400	InvalidParameter.NotEmpty	You must specify the parameter %s.	不合法的参数：%s不能为空。
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.	不合法的参数{%s}。
400	InvalidParameter.WithMessage	The parameter is invalid {%s}: %s	不合法的参数{%s}：%s。
500	OperationFailed.RPCError	Internal RPC request processing error.	内部RPC请求处理报错。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。