概览

更新时间:
复制 MD 格式

Sandbox API 的前提条件、Endpoint 拼装、鉴权方式,以及实例与模版管理的可用接口和错误响应。

说明调用前请先配置认证;错误处理见错误码。

Sandbox API 兼容 E2B 协议,提供沙箱实例的生命周期管理与模版管理能力。管控面请求经阿里云百炼 AI 网关转发。

前提条件

  1. 已开通阿里云百炼,并创建 API Key。
  2. 完成服务授权:首次使用 Sandbox 需完成 SLR 授权,详见快速开始。
  3. 获取工作空间 ID:阿里云百炼控制台右上角下拉菜单查看,形如 {workspace_id}。

Endpoint

API 基地址按工作空间与地域拼装:

https://{workspace_id}.{region}.maas.aliyuncs.com/api/v1/agentstudio/sandbox
  • workspace_id:工作空间 ID
  • region:地域 ID,当前仅支持 cn-beijing

可用 API

实例管理

能力方法路径
创建实例POST/sandboxes
列举实例GET/v2/sandboxes
获取实例GET/sandboxes/{sandboxID}
连接实例POST/sandboxes/{sandboxID}/connect
暂停实例POST/sandboxes/{sandboxID}/pause
恢复实例POST/sandboxes/{sandboxID}/resume
释放实例DELETE/sandboxes/{sandboxID}

模版管理

能力方法路径
创建模版POST/v3/templates
列举模版GET/v2/templates
获取模版GET/templates/{templateCode}
更新模版PUT/templates/{templateCode}
获取构建状态GET/templates/{templateCode}/builds/{buildID}/status
删除模版DELETE/templates/{templateCode}

E2B 官方参考

Sandbox 当前对外提供兼容 E2B 协议的 HTTP API。各接口的方法、路径与响应结构贴近 E2B 官方定义,除更新模版为阿里云百炼自定义协议外,其余接口的通用字段与语义可参阅 E2B 官方 API 文档:

说明本文仅列出阿里云百炼侧已支持的接口与阿里云百炼扩展字段。阿里云百炼侧的鉴权、Endpoint 与扩展配置以本文为准;通用协议字段可对照 E2B 官方文档理解。

SDK

除直接调用 REST 接口外,还可通过 E2B 官方 SDK 接入。详见实例管理与使用。