ListSessions API Overview for Session Filtering - Function Compute - Alibaba Cloud - Function Compute

Lists sessions in Active or Expired status under a specified function. Supports filtering by qualifier, status, and session ID, and supports paged query. Returns basic session properties for batch viewing of session distribution and status, facilitating operations management and external system integration, and improving session visibility and management capability.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

fc:ListSessions

list

*All Resource

*

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
functionName	string	No	The function name.	my-func

Request parameters

Parameter	Type	Required	Description	Example
qualifier	string	No	The function alias or version information.	aliasName1
limit	integer	No	The number of sessions to return. Default value: 20.	10
nextToken	string	No	The pagination token.	MTIzNCNhYmM=
sessionStatus	string	No	The session status to filter by. By default, all session information in Active or Expired status is returned. Set this parameter to Active to retrieve only active session information, or to Expired to retrieve only expired session information.	Active
sessionId	string	No	The session ID to filter by. If specified, all Active or Expired status information associated with this session is returned.	test-session-id-1

Response elements

Element	Type	Description	Example
	ListSessionsOutput	The list of session information returned.

Examples

Success response

JSON format

{
  "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
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.