ListSessions - 查询会话信息列表

更新时间:
复制 MD 格式

列举指定函数下Active/Expired 状态的会话列表,支持按 qualifier、状态、会话ID过滤,分页查询。返回会话基础属性,用于批量查看会话分布与状态,助力运维监控和外部系统集成,提升会话可见性与管理能力。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

fc:ListSessions

list

*全部资源

*

请求语法

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

路径参数

名称

类型

必填

描述

示例值

functionName

string

函数名

my-func

请求参数

名称

类型

必填

描述

示例值

qualifier

string

函数别名或版本信息

aliasName1

limit

integer

返回的会话数量,如不填写默认返回 20 条。

10

nextToken

string

分页起始标记

MTIzNCNhYmM=

sessionStatus

string

需要过滤的会话状态,默认返回所有 Active/Expired 状态的会话信息,也可指定 Active 仅获取活跃的会话信息,或指定 Expired 仅获取过期的会话信息。

Active

sessionId

string

过滤的 SessionId 值,如指定,可返回此会话关联的所有 Active/Expired 状态信息。

test-session-id-1

返回参数

名称

类型

描述

示例值

ListSessionsOutput

返回的会话信息列表

示例

正常返回示例

JSON格式

{
  "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": true
          }
        ]
      },
      "juiceFsConfig": {
        "mountPoints": [
          {
            "volumeName": "",
            "mountDir": "",
            "remoteDir": "",
            "token": "",
            "args": [
              ""
            ]
          }
        ],
        "envs": {
          "key": ""
        }
      },
      "enableAutoPause": true,
      "enableAutoResume": true
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情