概述

元数据允许您在创建沙箱时附加自定义键值对数据,用于关联用户会话、存储配置信息或标记沙箱用途。

设置元数据

在创建沙箱时通过 metadata 参数设置元数据。

import { Sandbox } from '@e2b/code-interpreter'

async function main() {
  const sandbox = await Sandbox.create({
    metadata: {
      userId: '123',
    },
  })
  await sandbox.kill()
}

main()

读取元数据

使用 Sandbox.list() 获取沙箱列表时,可以访问每个沙箱的元数据。

import { Sandbox } from '@e2b/code-interpreter'

async function main() {
  const paginator = await Sandbox.list()
  const runningSandboxes = await paginator.nextItems()

  if (runningSandboxes.length > 0) {
    console.log(runningSandboxes[0].metadata)
  }
}

main()

按元数据过滤

关于如何使用元数据字段过滤沙箱列表,请参考沙箱列表文档。