ListSandboxSessions - 查询 Sandbox 活动会话列表-智能体构建和治理平台 AgentCore-阿里云帮助中心

分页查询指定托管智能体的 Sandbox 中的活动 Session 列表，并返回会话来源及外部渠道类型。

接口说明

查询指定托管智能体 Sandbox 中的活动 Session 列表。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

agentcore:ListSandboxSessions

list

*全部资源

*

无

请求语法

GET /workspaces/{workspaceId}/managed-agents/{agentId}/sandboxes/{sandboxId}/sessions HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
workspaceId	string	是	工作空间 ID。	ws-1
agentId	string	是	托管智能体 ID。	agent-1
sandboxId	string	是	Sandbox ID，可通过 ListSandboxes 查询。	sbx-2

请求参数

名称	类型	必填	描述	示例值
maxResults	integer	否	单页最大记录数，默认 20	20
nextToken	string	否	查询下一页的游标	next-token-1

返回参数

名称	类型	描述	示例值
	object
requestId	string	请求 ID，用于定位和排查问题。	1a2b3c4d-xxxx-xxxx-xxxx-xxxxxxxxxxxx
message	string	响应消息，成功时为 success。	success
httpStatusCode	integer	HTTP 状态码，成功时为 200。	200
code	string	业务状态码，成功时为 SUCCESS。	SUCCESS
success	boolean	请求是否成功。true 表示成功，false 表示失败。
maxResults	integer	本次查询的单页最大记录数。	20
nextToken	string	下一页的分页令牌；为空表示没有更多结果。	next-token-1
totalCount	integer	符合本次查询条件的记录总数。	27
items	array<object>	该 Sandbox 的活动 Session 列表。
	object
sessionId	string	活动 Session 的唯一标识。	sess-2
sourceType	string	Session 来源类型。API 表示 API 调用，CONSOLE_DEBUG 表示控制台调试，EXTERNAL_CHANNEL 表示外部渠道，UNKNOWN 表示来源未知。枚举值： CONSOLE_DEBUG : 控制台调试 EXTERNAL_CHANNEL : 外部渠道 API : API 调用 UNKNOWN : 来源未知	EXTERNAL_CHANNEL
channelType	string	外部渠道类型，例如 DINGTALK、FEISHU、WECOM；非外部渠道为空	DINGTALK

示例

正常返回示例

JSON格式

{
  "requestId": "1a2b3c4d-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "message": "success",
  "httpStatusCode": 200,
  "code": "SUCCESS",
  "success": true,
  "maxResults": 20,
  "nextToken": "next-token-1",
  "totalCount": 27,
  "items": [
    {
      "sessionId": "sess-2",
      "sourceType": "EXTERNAL_CHANNEL",
      "channelType": "DINGTALK"
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。