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
RequestId	string	リクエスト ID	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
NextToken	string	この呼び出しで返されたページネーショントークン。	AAAAAdDWBF2****
Sessions	object
Session	array<object>	会話リスト。
	array<object>	セッション情報。
CreationTime	string	セッションが作成された時刻。	2024-01-19T09:15:46Z
TargetServer	string	インスタンスからアクセスされた VPC 内のサービスのアドレス。	192.168.0.246
PortNumber	integer	データ転送に使用されるインスタンスのポート番号。セッション作成時にデータ転送用のポート番号が指定されなかった場合、このパラメーターは空になります。	22
PrincipalId	string	プリンシパルの ID。 `IdentityType` の値に基づいた有効値：リクエスタが Alibaba Cloud アカウントを使用して操作を呼び出した場合、Alibaba Cloud アカウントの ID が返されます。リクエスタが Resource Access Management (RAM) ユーザーを使用して操作を呼び出した場合、RAM ユーザーの ID が返されます。リクエスタが RAM ロールを使用して操作を呼び出した場合、実際に操作を呼び出すプリンシパルの ID が返されます。	123456xxxx
Username	string	接続の確立に使用されたユーザー名。	root
ClientIP	string	接続の確立に使用されたクライアントの IP アドレス。	192.168.1.1
IdentityType	string	プリンシパルタイプ。有効値： Account: Alibaba Cloud アカウント RAMUser: RAM ユーザー AssumedRoleUser: RAM ロール	RAMUser
SessionId	string	セッション ID。	s-hz023od0x9****
Connections	object
Connection	array<object>	接続の情報。
	object	接続。
ClosedReason	string	接続が切断された理由。このパラメーターは、`Status` の値が `Disconnected`、`Terminated`、または `Failed` の場合にのみ返されます。有効値： InstanceNotExists: 指定されたインスタンスが存在しないか、リリースされました。 InstanceNotRunning: 指定されたインスタンスが実行中ではありませんでした。 DeliveryTimeout: 接続がタイムアウトしました。 AgentNeedUpgrade: クラウドアシスタントエージェントのアップグレードが必要でした。 AgentNotOnline: クラウドアシスタントエージェントがクラウドアシスタントサーバーに接続されていませんでした。 MessageFormatInvalid: メッセージ形式が無効でした。 AgentSocketClosed: 接続が正常に切断されました。 ClientClosed: セッションマネージャークライアントが接続を切断しました。	AgentNeedUpgrade
EndTime	string	接続が切断された時刻。	2024-01-19T09:16:46Z
Status	string	セッションの状態。有効値： Connecting: 接続を確立中です。 Connected: 接続が確立されました。 Terminated: セッションは終了しました。 Failed: 接続に失敗しました。	Connecting
StartTime	string	接続の確立が開始された時刻。	2024-01-19T09:16:40Z
InstanceId	string	インスタンス ID。	i-bp1i7gg30r52z2em****
FailedDetail	string	接続失敗の原因。このパラメーターは、Status パラメーターが Failed の場合にのみ返されます。	The Session Manager is closed normally.

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidParameter.NextToken	The specified parameter NextToken is not valid.
400	InvalidParameter.MaxResults	The specified parameter MaxResults is not valid.
500	InternalError	An error occurred when you dispatched the request.
403	Operation.Forbidden	The operation is not permitted.
404	InvalidRegionId.NotFound	The specified parameter RegionId does not exist.

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

変更履歴

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