DocsICP FilingConsole
官方文档
首页

GetWebshellToken

更新时间：
复制 MD 格式
产品详情
我的收藏

Obtains the token used to remotely log on to the Webshell of an instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

sae:GetWebshellToken

get

*All Resource

*

 None None

Request syntax

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

Request parameters

Parameter

Type

Required

Description

Example
AppId

string

Yes

The ID of the interactive messaging application.

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

string

Yes

The name of the pod.

hello-podsdfsdfsdfsdf
ContainerName

string

No

The name of the init container.

Note:

  • If you specify this parameter, Cloud Assistant runs the command in the specified container of the instances.

  • If this parameter is specified, the command can run only on Linux instances on which Cloud Assistant Agent 2.2.3.344 or later is installed.

  • If this parameter is specified, the Username parameter that is specified in a request to call this operation and the WorkingDir parameter that is specified in a request to call the CreateCommand operation do not take effect. You can run the command only in the default working directory of the container by using the default user of the container. For more information, see Use Cloud Assistant to run commands in containers.

  • If this parameter is specified, only shell scripts can be run in Linux containers. You cannot add a command in the format similar to #!/usr/bin/python at the beginning of a script to specify a script interpreter. For more information, see Use Cloud Assistant to run commands in containers.

ad-helper

Response elements

Element

Type

Description

Example

object

RequestId

string

Request ID.

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

string

The returned message. Value description:

  • If the request was successful, a success message is returned.

  • An error code is returned if the request failed.

success
TraceId

string

The ID of the trace.

0a98a02315955564772843261e****
Data

object

The returned result.

Token

string

The information about the token.

zWWpvRj_5pzof4hfo7-hGynM8oGMmO_7
HttpUrl

string

Webshell page address

HttpUrl : "https://saenext.console.aliyun.com/cn-shenzhen/app-list/app1/micro-app/shell/pod1?tokenId=xxx
WebSocketUrl

string

The WebSocket address.

wss://sae-webshell.console.aliyun.com/websocket/eamWebshell?tokenId=xxx&region=cn-shenzhen
ErrorCode

string

The error code returned if the call failed. Value values:

  • If the request was successful, ErrorCode is not returned.

  • If the request failed, the ErrorCode parameter is returned. For more information, see Error codes section in this topic.

400
Code

string

The HTTP status code. Valid values:

  • 2xx: The request was successful.

  • 3xx: The request was redirected.

  • 4xx: The request failed.

  • 5xx: A server error occurred.

200
Success

boolean

Indicates whether the request was successful.

true

Examples

Success response

JSON format

{
  "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": "400",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code

Error code

Error message

Description
400 InvalidApplication.NotFound The current application does not exist.
400 InvalidParameter.NotEmpty You must specify the parameter %s.
400 InvalidParameter.Obviously The specified parameter is invalid {%s}.
400 InvalidParameter.WithMessage The parameter is invalid {%s}: %s
500 OperationFailed.RPCError Internal RPC request processing error. Internal RPC request processing error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.