通过自定义筛选条件批量查询工具的会话详情。

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：ListSessions

要执行的操作，取值：ListSessions。

Version string 必选示例值：2025-10-30

API的版本，取值：2025-10-30。

CreateTimeAfter string 可选示例值：2006-01-02T15:04:05Z07:00

筛选该时间点后创建的会话。（RFC3339格式）

CreateTimeBefore string 可选示例值：2006-01-02T15:04:05Z07:00

筛选该时间点前创建的会话。（RFC3339格式）

ExpireTimeAfter string 可选示例值：2006-01-02T15:04:05Z07:00

筛选该时间点后更新的会话。（RFC3339格式）

ExpireTimeBefore string 可选示例值：2006-01-02T15:04:05Z07:00

筛选该时间点前更新的会话。（RFC3339格式）

Filters.N.Name string[] 可选示例值：UserSessionId

支持精确过滤的字段名。

参数 - N：表示过滤条件的序号，取值范围：1～10。

多个字段名之间用&分隔，为“或”的关系。

取值：

Id：会话ID。

UserSessionId：会话信息。

Status：会话状态。

说明

当Filters.N.Name和Filters.N.NameContains同时传入时，仅Filters.N.Name生效。

Filters.N.NameContains string[] 可选示例值：Status

模糊过滤的字段名，取值：

参数 - N：表示过滤条件的序号，取值范围：1～10。

多个字段名之间用&分隔，为“或”的关系。

取值：

Id：会话ID。

UserSessionId：会话信息。

Status：会话状态。

说明

当Filters.N.Name和Filters.N.NameContains同时传入时，仅Filters.N.Name生效。

Filters.N.Values.N string[] 可选示例值：Ready

过滤字段的值。

参数 - N：表示过滤条件的序号，取值范围：1～10。

多个字段名之间用&分隔。

当过滤字段为Status时，取值：

Starting: 启动中。

Ready: 运行中。

Failed: 启动失败。

Terminating: 终止中。

MaxResults integer 可选示例值：10

分页查询时设置的每页行数。

最小值：1。

最大值：100。

默认值：100。

NextToken string 可选示例值：unique-token

分页查询凭证，用于标记分页的位置，初次调用该接口时无需设置。下次查询时，取值为上一次API调用返回的NextToken参数值。

Metadata.N.Key string[] 必选示例值：env

元数据的标签键，如env、version等自定义标识。

参数 - N：表示标签Key的序号，取值范围：1～10。

单个Key的长度限制为128个字符。

多个字段名之间用&分隔，且不可重复。

ToolId string 必选示例值：t-3tigy72q3u3vj0x2****

工具ID。

Metadata.N.Value string[] 可选示例值：production

元数据的标签值。

参数 - N：表示标签值的序号，取值范围：1～10。

单个值的长度限制为 256个字符，多个字段名之间用&分隔。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

NextToken string 示例值：bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq******

本次调用返回的查询凭证值，返回为空表示该页为末页。

SessionInfos object[] 示例值：--

符合查询条件的实例信息。

CreatedAt string 示例值：2006-01-02T15:04:05Z07:00

会话创建时间。

Endpoint string 示例值：https://sd391h67itqkq7brr****.apigateway-cn-beijing.volceapi.com

会话公网访问端点。

ExpireAt string 示例值：2006-01-02T15:04:05Z07:00

会话过期时间。

InternalEndpoint string 示例值：https://sd391h67itqkq7brr****.apigateway-cn-beijing.volceapi.com

会话私网访问端点。

Metadata object[] 示例值：--

元数据的信息。

Key string 示例值：evn

元数据的Key。

Type string 示例值：String

元数据的类型。

Value string 示例值：production

元数据的值。

SessionId string 示例值：s-3tigy72q3u3vj0x2****

会话ID。

SessionMeta object 示例值：--

会话元数据。

VncUrl string 示例值：http://sd3s4ng567ui2e1ad****.apigateway-cn-beijing.volceapi.com/terminal?faasInstanceName=vefaas-bf5xfrv4-qa6b0ee7db-d3vh9b033fo44goh****-sandbox

会话VNC访问链接。

WebshellUrl string 示例值：http://sd3s4ng567ui2e1ad****.apigateway-cn-beijing.volceapi.com/vnc/index.html?faasInstanceName=vefaas-bf5xfrv4-qa6b0ee7db-d3vh9b033fo44goh****-sandbox

会话Webshell访问链接。

Status string 示例值：Ready

会话状态，取值：

Starting: 启动中。

Ready: 运行中。

Failed: 启动失败。

Terminating: 终止中。

ToolType string 示例值：All-in-one

工具类型。取值：

All-in-one：一体化工具集，即预置工具AIO Sandbox。

Skill: Skill工具镜像，即预置工具Skills Sandbox。

Private: 自定义工具。

TosMountPoints object[] 示例值：--

会话实例TOS挂载点信息。

BucketName string 示例值：bucket01

TOS存储桶名称。

BucketPath string 示例值：http://tos-cn-beijing.ivolces.com

TOS存储桶路径。

LocalMountPath string 示例值：/home/app

待挂载的工具实例本地目录。

UserSessionId string 示例值：session01

用户会话信息。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	LimitExceeded.MaximumFilters	The number of specified Filters exceeds the maximum limit.	指定的Filters超过最大限制。
400	MissingParameter.Key	The required parameter Key is not supplied.	参数Key不能为空。
400	MissingParameter.ToolId	The required parameter ToolId is not supplied.	tool id不能为空。
404	InvalidResource.NotFound	The specified resource does not exist.	资源不存在。

AgentKit