ListSandboxes - 查询 Sandbox 列表

更新时间:
复制 MD 格式

查询指定工作空间中托管智能体的 Sandbox 列表,支持按 Sandbox ID 和当前有效 Session ID 的片段组合筛选。

接口说明

查询指定托管智能体的 Sandbox 列表;searchText 按 Sandbox ID 片段模糊匹配,sessionId 按当前有效 Session ID 片段模糊匹配,两者可同时传入并按 AND 组合。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

agentcore:ListSandboxes

list

*全部资源

*

无 无

请求语法

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

路径参数

名称

类型

必填

描述

示例值

workspaceId

string

是

工作空间 ID。

ws-1

agentId

string

是

托管智能体 ID。

agent-1

请求参数

名称

类型

必填

描述

示例值

searchText

string

否

按 Sandbox ID 片段模糊搜索,不区分大小写

2f360

sessionId

string

否

按当前有效 Session ID 片段模糊搜索,不区分大小写

session-a

maxResults

integer

否

单页最大记录数,默认 20

20

nextToken

string

否

查询下一页的游标;翻页时须保持 workspaceId、agentId、searchText、sessionId 和 maxResults 不变

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 列表。

object

sandboxId

string

Sandbox ID,可通过 ListSandboxes 查询。

sbx-2

phase

string

Sandbox 当前运行阶段。

枚举值:

  • HIBERNATING :

    休眠中

  • FAILED :

    运行失败

  • RUNNING :

    运行中

  • TERMINATING :

    销毁中

  • RESUMING :

    恢复中

  • PENDING :

    创建或初始化中

  • HIBERNATED :

    已休眠

RUNNING

activeSessionCount

integer

该 Sandbox 当前的活动 Session 数量。

1

maxConcurrentSessions

integer

该 Sandbox 允许的最大并发 Session 数,取自运行时生效的自动扩缩容配置;自动扩缩容未启用或配置不可用时为空。

7

createdAt

string

Sandbox 创建时间,采用 RFC 3339 UTC 格式。

2026-08-29T00:00:00Z

lastHeartbeatAt

string

Sandbox 最近一次心跳时间,采用 RFC 3339 UTC 格式。

2026-08-29T00:01:00Z

lastActiveAt

string

Sandbox 最近一次活动时间,采用 RFC 3339 UTC 格式。

2026-08-29T00:02:00Z

示例

正常返回示例

JSON格式

{
  "requestId": "1a2b3c4d-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "message": "success",
  "httpStatusCode": 200,
  "code": "SUCCESS",
  "success": true,
  "maxResults": 20,
  "nextToken": "next-token-1",
  "totalCount": 27,
  "items": [
    {
      "sandboxId": "sbx-2",
      "phase": "RUNNING",
      "activeSessionCount": 1,
      "maxConcurrentSessions": 7,
      "createdAt": "2026-08-29T00:00:00Z",
      "lastHeartbeatAt": "2026-08-29T00:01:00Z",
      "lastActiveAt": "2026-08-29T00:02:00Z"
    }
  ]
}

错误码

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

变更历史

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