沙箱

列出沙箱

分页列出你当前运行中的沙箱,可按状态筛选。

GET /sandbox/v1/sandboxes● 支持

E2B 官方文档 ↗

请求参数

  • metadatastring可选

    query: Metadata query used to filter the sandboxes (e.g. "user=abc&app=prod"). Each key and values must be URL encoded.

  • statearray可选

    query: live:运行中;exited:已退出;all:全部保留记录。默认 live。

  • orderstring可选
    默认 "desc"

    query: Sort direction by sandbox start time. Defaults to desc (newest first).

    取值 ascdesc
  • startedAfterstring可选

    query: Return sandboxes started at or after this timestamp.

  • templatestring可选

    query: Filter sandboxes by a template ID or alias.

  • nextTokenstring可选

    query: Cursor to start the list from

  • limitinteger可选
    默认 100

    query: Maximum number of items to return per page

  • namestring可选

    query: 按名称子串搜索,不区分大小写;中文、%、_ 和反斜杠按原样匹配。去除首尾空白后须为 1–64 个字符。可与状态及分页参数组合;历史空名称不匹配。

返回

200

错误按 E2B 格式返回,参见 错误码

响应

HTTP 200

Successfully returned all running sandboxes

application/json

名称类型说明
[].templateIDstringIdentifier of the template from which is the sandbox created
[].aliasstringAlias of the template
[].sandboxIDstringIdentifier of the sandbox
[].clientIDstringIdentifier of the client
[].startedAtstringTime when the sandbox was started
[].endAtstringTime when the sandbox will expire
[].cpuCountintegerCPU cores for the sandbox
[].memoryMBintegerMemory for the sandbox in MiB
[].diskSizeMBintegerDisk size for the sandbox in MiB
[].metadataanyYour own string key/value pairs stored with the sandbox; usable as a filter in listSandboxes.
[].statestringState of the sandbox
[].envdVersionstringVersion of the envd running in the sandbox
[].volumeMountsarray<object>Volumes mounted into the sandbox.
[].volumeMounts[].namestringName of the volume
[].volumeMounts[].pathstringPath of the volume