Instance Management

Create Instance

Create a sandbox instance from a template

POST

/api/v1/agentstudio/sandbox/sandboxes

cURL

curl --request POST \
  --url 'https://{workspace_id}.{region}.maas.aliyuncs.com/api/v1/agentstudio/sandbox/sandboxes' \
  --header 'Authorization: Bearer <YOUR_API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "templateID": "<string>",
  "timeout": 0,
  "allow_internet_access": false,
  "metadata": {},
  "envVars": {},
  "autoPause": false,
  "autoResume": false,
  "lifecycle": {
    "on_timeout": "<string>",
    "auto_resume": false
  },
  "network": {
    "allowOut": [
      "<string>"
    ],
    "denyOut": [
      "<string>"
    ],
    "maskRequestHost": "<string>",
    "rules": {}
  }
}
'

{
  "clientID": "<string>",
  "sandboxID": "<string>",
  "bailianSandboxId": "<string>",
  "templateID": "<string>",
  "alias": "<string>",
  "envdVersion": "<string>",
  "domain": "<string>",
  "envdAccessToken": "<string>",
  "trafficAccessToken": "<string>",
  "envdUrl": "<string>",
  "state": "<string>"
}

Authorizations

string

header

required

Body

application/json

string

required

已创建且构建完成的模版 ID

integer

实例生命周期时间，单位秒，取值范围 [300,604800]

Required range:300 <= x <= 604800

boolean

是否允许实例访问公网

object

自定义元数据，键和值均为字符串

object

实例级环境变量

boolean

timeout 到期后是否暂停实例

boolean

是否在连接时自动恢复；兼容对象形式 {"enabled": true}

object

生命周期配置

Show child attributes

string

到期行为，pause 表示到期暂停；也可传对象形式携带 action

boolean

暂停后连接是否自动恢复

object

实例级网络配置。兼容 allow_public_traffic、allow_out、deny_out、mask_request_host

Show child attributes

string[]

出口白名单

string[]

出口黑名单

string

可选的请求 Host 覆盖

object

扩展网络规则

Response

201-application/json

string

客户端标识

string

实例唯一 ID，用于后续生命周期与数据面调用

string

百炼扩展标识；开发者通常无需使用

string

模版 ID

string

模版别名

string

envd 版本

string

数据面访问域名

string

envd 访问 token

string | null

流量访问 token

string

envd 访问地址

string

实例状态，例如 running

cURL

curl --request POST \
  --url 'https://{workspace_id}.{region}.maas.aliyuncs.com/api/v1/agentstudio/sandbox/sandboxes' \
  --header 'Authorization: Bearer <YOUR_API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "templateID": "<string>",
  "timeout": 0,
  "allow_internet_access": false,
  "metadata": {},
  "envVars": {},
  "autoPause": false,
  "autoResume": false,
  "lifecycle": {
    "on_timeout": "<string>",
    "auto_resume": false
  },
  "network": {
    "allowOut": [
      "<string>"
    ],
    "denyOut": [
      "<string>"
    ],
    "maskRequestHost": "<string>",
    "rules": {}
  }
}
'

{
  "clientID": "<string>",
  "sandboxID": "<string>",
  "bailianSandboxId": "<string>",
  "templateID": "<string>",
  "alias": "<string>",
  "envdVersion": "<string>",
  "domain": "<string>",
  "envdAccessToken": "<string>",
  "trafficAccessToken": "<string>",
  "envdUrl": "<string>",
  "state": "<string>"
}