セッションフィルタリングのための ListSessions API 概要 - FC - Alibaba Cloud - Function Compute

指定された関数配下のアクティブなまたは期限切れのステータスの会話の一覧を表示します。オペレーター、ステータス、会話 ID によるフィルターおよびページングをサポートします。会話の基本的なプロパティを返すことで、会話のディストリビューションとステータスをバッチで確認でき、サービス監視や外部システムとの連携を容易にし、会話の可視性と管理機能を向上させます。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

fc:ListSessions

list

*All Resource

*

なし

リクエスト構文

GET /2023-03-30/functions/{functionName}/sessions HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
functionName	string	任意	関数の名前。	my-func

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
qualifier	string	任意	関数のエイリアスまたはバージョン情報。	エイリアスName1
limit	integer	任意	返される会話の数。デフォルト値: 20。	10
nextToken	string	任意	ページネーショントークン。	MTIzNCNhYmM=
sessionStatus	string	任意	フィルター対象の会話ステータス。デフォルトでは、アクティブなまたは期限切れのステータスのすべての会話情報が返されます。Active を指定してアクティブな会話情報のみを取得することも、Expired を指定して期限切れの会話情報のみを取得することもできます。	Active
sessionId	string	任意	フィルター対象の会話 ID。指定した場合、この会話に関連するすべてのアクティブなまたは期限切れのステータス情報が返されます。	test-会話-id-1

レスポンスフィールド

フィールド	型	説明	例
	ListSessionsOutput	返される会話情報のリスト。

例

成功レスポンス

JSONJSON

{
  "nextToken": "MTIzNCNhYmM=",
  "sessions": [
    {
      "sessionId": "81f70ae156904eb9b7d43e12f511fe58",
      "functionName": "functionName1",
      "sessionAffinityType": "HEADER_FIELD",
      "sessionTTLInSeconds": 21600,
      "sessionIdleTimeoutInSeconds": 1800,
      "createdTime": "2025-04-01T08:15:27Z",
      "lastModifiedTime": "2025-04-01T18:15:27Z",
      "sessionStatus": "Active",
      "containerId": "c-68999e02-16a1955c-d2a03d1ccs",
      "qualifier": "AliasName1",
      "nasConfig": {
        "groupId": 100,
        "mountPoints": [
          {
            "enableTLS": true,
            "mountDir": "/home/test",
            "serverAddr": "***-uni85.cn-hangzhou.nas.com:/"
          }
        ],
        "userId": 100
      },
      "disableSessionIdReuse": false,
      "ossMountConfig": {
        "mountPoints": [
          {
            "bucketName": "my-bucket",
            "bucketPath": "/my-dir",
            "endpoint": "http://oss-cn-shanghai.aliyuncs.com",
            "mountDir": "/mnt/dir",
            "readOnly": true
          }
        ]
      },
      "polarFsConfig": {
        "groupId": 0,
        "userId": 0,
        "mountPoints": [
          {
            "instanceId": "",
            "mountDir": "",
            "remoteDir": "",
            "readOnly": false
          }
        ]
      },
      "juiceFsConfig": {
        "mountPoints": [
          {
            "volumeName": "",
            "mountDir": "",
            "remoteDir": "",
            "token": "",
            "args": [
              ""
            ]
          }
        ],
        "envs": {
          "key": ""
        }
      },
      "enableAutoPause": false,
      "enableAutoResume": false,
      "allowInternetAccess": false,
      "network": {
        "allowPublicTraffic": false,
        "maskRequestHost": "",
        "allowOut": [
          ""
        ],
        "denyOut": [
          ""
        ]
      },
      "trafficAccessToken": ""
    }
  ]
}

エラーコード

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

変更履歴

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