全部产品
Search
文档中心

:GetWebshellToken - 获取远程登录Token

更新时间:Dec 05, 2024

获取远程登录实例 Web Shell 的 Token

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
sae:GetWebshellToken
*全部资源
*

请求语法

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

请求参数

名称类型必填描述示例值
AppIdstring

应用 ID。

017f39b8-dfa4-4e16-a84b-1dcee4b1****
PodNamestring

Pod 名称。

hello-podsdfsdfsdfsdf

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Messagestring

调用结果的附加信息。取值说明如下:

  • 请求正常,返回 success。
  • 请求异常,返回具体异常错误码。
success
TraceIdstring

调用链 ID。

0a98a02315955564772843261e****
Dataobject

返回结果。

Tokenstring

Token 信息。

zWWpvRj_5pzof4hfo7-hGynM8oGMmO_7
ErrorCodestring

错误码。取值说明如下:

  • 请求成功:不返回 ErrorCode 字段。
  • 请求失败:返回 ErrorCode 字段。具体信息,请参见本文的错误码目录。
Codestring

HTTP 状态码。取值说明如下:

  • 2xx:成功。
  • 3xx:重定向。
  • 4xx:请求错误。
  • 5xx:服务器错误。
200
Successboolean

是否成功。

true

示例

正常返回示例

JSON格式

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "Token": "zWWpvRj_5pzof4hfo7-hGynM8oGMmO_7"
  },
  "ErrorCode": "空",
  "Code": "200",
  "Success": true
}

错误码

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

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