DescribeTerminalSessions - Elastic Compute Service - Alibaba Cloud ドキュメントセンター

Session Manager の会話履歴を照会します。

操作説明

過去 30 日以内に作成された Session Manager の会話記録をクエリできます。成功した記録の最大値は 1,000 件です。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ecs:DescribeTerminalSessions

list

*Instance。

acs:ecs:{#regionId}:{#accountId}:instance/{#InstanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。	cn-hangzhou
InstanceId	string	任意	インスタンス ID	i-bp1i7gg30r52z2em****
SessionId	string	任意	会話 ID。	s-hz023od0x9****
MaxResults	integer	任意	ページングクエリの 1 ページあたりのエントリの最大数。最大値: 100。デフォルト値: 10。	10
NextToken	string	任意	ページネーショントークン。このパラメーターには、前の API 呼び出しで返された NextToken 値を設定します。	AAAAAdDWBF2****

レスポンスフィールド

フィールド	型	説明	例
	object
NextToken	string	この呼び出しで返されるページネーショントークン。	AAAAAdDWBF2****
RequestId	string	リクエスト ID	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
Sessions	object
Session	array<object>	会話リスト。
	array<object>	セッション情報。
ClientIP	string	リモート接続のクライアント IP アドレス。	192.168.1.1
Connections	object
Connection	array<object>	接続情報リスト。
	object	接続情報。
ClosedReason	string	接続が閉じられた理由。このパラメーターは、Status が Disconnected、Terminated、または Failed の場合にのみ返されます。有効な値: InstanceNotExists: 指定されたインスタンスが存在しないか、リリースされています。 InstanceNotRunning: インスタンスが実行中ではありません。 DeliveryTimeout: 接続がタイムアウトしました。 AgentNeedUpgrade: クラウドアシスタントエージェントをアップグレードする必要があります。 AgentNotOnline: クラウドアシスタントエージェントがサーバーに接続されていません。 MessageFormatInvalid: メッセージの初期化が無効です。 AgentSocketClosed: 接続は正常に閉じられました。 ClientClosed: 会話管理クライアントが接続を閉じました。 ReadFromTargetPortFailed: StartTerminalSession で指定された PortNumber を使用したデータ転送中に、ターゲットポートからデータの読み取りに失敗した。 ReopenTargetPortFailed: StartTerminalSession で指定された PortNumber を使用したデータ転送中に、ターゲットポートへの TCP 接続の再確立に失敗した。 OpenTargetPortFailed: StartTerminalSession で指定された PortNumber を使用したデータ転送中に、ターゲットポートへの TCP 接続の確立に失敗した。 WinptyPermissionDenied: Windows インスタンスの場合、指定されたユーザーに winpty.dll または winpty-agent.exe の読み取りおよび実行する権限の付与に失敗した。 PasswordNameNotFound: StartTerminalSession で指定された PasswordName が見つかりませんでした。 ProcessSessionDataError: 会話データのプロセスに失敗した。 SessionIdDuplicate: 会話 ID が重複しています。 SessionTimeout: 会話がタイムアウトしました。3 時間を超える会話接続はプロアクティブに切断されます。 IdleTimeout: 接続がタイムアウトしました。180 秒間会話のやり取りがない接続はアイドルと見なされ、プロアクティブに切断されます。 HomeDirPermissionDenied: 接続先ユーザーのホームディレクトリに対する権限が不足しています。 HomeDirNotFound: 接続先ユーザーのホームディレクトリが存在しません。 ShellCommandPermissionDenied: シェルプログラムに対する権限が不足しています。bash または csh に実行する権限がありません。 ShellCommandNotFound: シェルプログラムが存在しません。Linux の bash ファイル、FreeBSD の csh ファイル、または Windows の powershell.exe ファイルが存在しません。 ObtainUserInfoFailed: Username パラメーター情報 (ホームディレクトリ情報) の取得に失敗した。 ObtainUserIdentityFailed: Username パラメーターの認証情報 (uid、gid、groups) の取得に失敗した。 UserNotExists: StartTerminalSession で指定された Username が存在しません。 MalformedCommandLine: StartTerminalSession で指定された CommandLine の解析に失敗した。	AgentNeedUpgrade
EndTime	string	接続が終了した時間。時間は ISO 8601 初期化の協定世界時 (UTC) で表示されます。	2024-01-19T09:16:46Z
FailedDetail	string	接続失敗の詳細。このパラメーターは、Status が Failed の場合にのみ返されます。	Session Manager は正常に閉じられました
InstanceId	string	インスタンス ID	i-bp1i7gg30r52z2em****
StartTime	string	接続が開始された時間。時間は ISO 8601 初期化の協定世界時 (UTC) で表示されます。	2024-01-19T09:16:40Z
Status	string	会話のステータス。有効な値: Connecting: 会話を接続中です。 Connected: 会話が接続されています。 Terminated: 会話が終了しています。 Failed: 接続に失敗した。	Connecting
CreationTime	string	会話が作成された時間。時間は ISO 8601 初期化の協定世界時 (UTC) で表示されます。	2024-01-19T09:15:46Z
IdentityType	string	ID タイプ。有効な値: Account: Alibaba Cloud アカウント。 RAMUser: リソースアクセス管理 (RAM) ユーザー。 AssumedRoleUser: RAM ロール。	RAMUser
PortNumber	integer	データ転送に使用される ECS インスタンスのポート番号。データ転送用にポート番号が設定されていない場合、この値は空です。	22
PrincipalId	string	ID。IdentityType に基づいて値は異なります。呼び出し元が Alibaba Cloud アカウントの場合: Alibaba Cloud アカウント ID が返されます。呼び出し元がリソースアクセス管理 (RAM) ユーザーの場合: RAM ユーザー ID が返されます。呼び出し元がロールの引き受けを通じて API を呼び出す場合: ロールの引き受けの実際のデリゲート ID が返されます。	123456xxxx
SessionId	string	会話 ID。	s-hz023od0x9****
TargetServer	string	インスタンス経由でアクセスされる VPC 内のターゲットサーバーのアドレス。	192.168.0.246
Username	string	接続に使用されるユーザー名。	root

例

成功レスポンス

JSONJSON

{
  "NextToken": "AAAAAdDWBF2****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "Sessions": {
    "Session": [
      {
        "ClientIP": "192.168.1.1",
        "Connections": {
          "Connection": [
            {
              "ClosedReason": "AgentNeedUpgrade",
              "EndTime": "2024-01-19T09:16:46Z",
              "FailedDetail": "Session Manager は正常に終了しました",
              "InstanceId": "i-bp1i7gg30r52z2em****",
              "StartTime": "2024-01-19T09:16:40Z",
              "Status": "Connecting"
            }
          ]
        },
        "CreationTime": "2024-01-19T09:15:46Z",
        "IdentityType": "RAMUser",
        "PortNumber": 22,
        "PrincipalId": "123456xxxx",
        "SessionId": "s-hz023od0x9****",
        "TargetServer": "192.168.0.246",
        "Username": "root"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParameter.NextToken	The specified parameter NextToken is not valid.
400	InvalidParameter.MaxResults	The specified parameter MaxResults is not valid.	指定された MaxResults パラメーターは無効です。
500	InternalError	An error occurred when you dispatched the request.	内部エラーが発生しました。再度お試しください。
403	InvalidParameterCharacter	The specified parameter %s contains illegal characters.
403	Operation.Forbidden	The operation is not permitted.	操作は許可されていません。
404	InvalidRegionId.NotFound	The specified parameter RegionId does not exist.	指定された RegionId は存在しません。このリージョンでプロダクトが利用可能かどうかを確認してください。

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

変更履歴

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