列出 Sandbox。
接口说明
获取当前用户的所有沙箱列表，支持按模板名称过滤，支持分页查询。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| agentrun:ListSandboxes | list | *全部资源 * |
| 无 |
请求语法
GET /2025-09-10/sandboxes HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| templateName | string | 否 | 模板名称 | templateName |
| templateType | string | 否 | 模板类型 | TASK |
| maxResults | integer | 否 | 页码 | 1000 |
| nextToken | string | 否 | 分页游标。 说明 该字段不为空，表示有更多数据。 | dnLkmeaJc9vHgbzREh2l0J4dD+2BRJj42DLT6GrZysw= |
| status | string | 否 | 状态 | CREATING |
返回参数
示例
正常返回示例
JSON格式
{
"code": "",
"requestId": "",
"data": {
"nextToken": "",
"items": [
{
"sandboxId": "",
"templateId": "",
"templateName": "",
"status": "",
"createdAt": "",
"lastUpdatedAt": "",
"sandboxIdleTimeoutSeconds": 0,
"endedAt": "",
"sandboxArn": "",
"sandboxIdleTTLInSeconds": 0,
"metadata": {
"test": "test",
"test2": 1
}
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2025-11-23 | API 内部配置变更，不影响调用 | 查看变更详情 |
| 2025-11-20 | 新增 OpenAPI | 查看变更详情 |