すべてのプロダクト
Search
ドキュメントセンター

Simple Application Server:StartTerminalSession

最終更新日:Mar 02, 2026

Simple Application Server インスタンスにログインするためのセッションを開始します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

swas-open:StartTerminalSession

none

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionId

string

必須

Simple Application Server インスタンスが設置されているリージョン ID。 ListRegions 操作を呼び出して、Alibaba Cloud の最新のリージョンリストをクエリできます。

cn-hangzhou

InstanceId

string

必須

Simple Application Server インスタンスの ID。

ace0706b2ac4454d984295a94213****

CommandLine

string

任意

セッションの開始後に実行するコマンド。 コマンドの長さは 512 文字までです。

ssh root@192.168.0.***

レスポンスフィールド

フィールド

説明

object

応答のスキーマ

RequestId

string

リクエスト ID。

20758A-585D-4A41-A9B2-28DA8F4F****

SessionId

string

セッション ID。

ffb90b6e-b18a-4a33-88cf-86fb88****

SecurityToken

string

認証用の WebSocket リクエストのリクエストヘッダーに含まれるセキュリティトークン。

token-xxxaaz

WebSocketUrl

string

Simple Application Server インスタンスにリモート接続するために使用される WebSocket セッションの URL。 URL には、認証に使用されるセッション ID (SessionId) とセキュリティトークン (SecurityToken) が含まれています。

wss://xxxx

成功レスポンス

JSONJSON

{
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F****",
  "SessionId": "ffb90b6e-b18a-4a33-88cf-86fb88****",
  "SecurityToken": "token-xxxaaz",
  "WebSocketUrl": "wss://xxxx"
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 UserBehaviour.SessionManagerDisabled The API is disabled by user behaviour.

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

変更履歴

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