すべてのプロダクト
Search

このプロダクト

    Serverless App Engine:GetWebshellToken

    ドキュメントセンター

    Serverless App Engine:GetWebshellToken

    最終更新日:Apr 22, 2026

    インスタンスの Webshell にリモートログインするためのトークンを取得します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    sae:GetWebshellToken

    get

    *All Resource

    *

    		 なし なし

    リクエスト構文

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

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    AppId

    string

    必須

    アプリケーションの ID。

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

    string

    必須

    Pod の名前。

    hello-podsdfsdfsdfsdf
    ContainerName

    string

    任意

    init コンテナの名前。

    注：

    • このパラメーターを指定すると、クラウドアシスタントはインスタンスの指定されたコンテナでコマンドを実行します。

    • このパラメーターを指定した場合、コマンドはクラウドアシスタントエージェント 2.2.3.344 以降がインストールされている Linux インスタンスでのみ実行できます。

    • このパラメーターを指定した場合、この操作を呼び出すリクエストで指定された Username パラメーターと、CreateCommand 操作を呼び出すリクエストで指定された WorkingDir パラメーターは有効になりません。コンテナのデフォルトユーザーを使用して、コンテナのデフォルトの作業ディレクトリでのみコマンドを実行できます。詳細については、「クラウドアシスタントを使用してコンテナでコマンドを実行する」をご参照ください。

    • このパラメーターを指定した場合、Linux コンテナではシェルスクリプトのみ実行できます。スクリプトの先頭に #!/usr/bin/python のような形式のコマンドを追加して、スクリプトインタープリターを指定することはできません。詳細については、「クラウドアシスタントを使用してコンテナでコマンドを実行する」をご参照ください。

    ad-helper

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

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

    string

    返されたメッセージ。値の説明：

    • リクエストが成功した場合、成功メッセージが返されます。

    • リクエストが失敗した場合、エラーコードが返されます。

    success
    TraceId

    string

    トレースの ID。

    0a98a02315955564772843261e****
    Data

    object

    返された結果。

    Token

    string

    トークンに関する情報。

    zWWpvRj_5pzof4hfo7-hGynM8oGMmO_7
    HttpUrl

    string

    Webshell ページのアドレス

    HttpUrl : "https://sae.console.alibabacloud.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

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "Token": "zWWpvRj_5pzof4hfo7-hGynM8oGMmO_7",
    "HttpUrl": "HttpUrl :  \"https://sae.console.alibabacloud.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 ステータスコード

    エラーコード

    エラーメッセージ

    説明
    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.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。