火山方舟
火山方舟
API参考
请输入
- 文档首页
火山方舟Managed Agents APIEnvironments归档环境
复制全文
下载 pdf归档环境
文档反馈
问问助手POST https://ark.cn-beijing.volces.com/api/v3/environments/{environment_id}/archive
当某个 Environment 不再承接新会话，但仍需保留配置供查询时，调用本接口将其归档。归档后，方舟保留 Environment 的控制面配置记录并写入 archived_at，但不会迁移或备份云沙箱、TOS 对象，以及企业侧 Worker、Sandbox、文件、日志和产物。
归档后的 Environment 不能更新，也不能用于创建新会话，但已有会话会继续使用创建时保存的环境配置；重复调用不会改变首次归档时间。
鉴权
- API Key 鉴权，请在 API Key 管理 页面，获取长效 API Key。
请求参数
Path 参数
environment_id string 必选 | 环境 ID
要归档的 Environment ID，以 env- 开头。可从创建环境响应或环境列表中获取。
响应参数
created_at string | 创建时间
Environment 创建时间，采用 RFC 3339 格式的 UTC 时间。
id string | 环境 ID
Environment ID，由服务端生成，以 env- 开头。
name string | 环境名称
Environment 的名称。
type string | 对象类型
对象类型，固定为 environment。
updated_at string | 更新时间
Environment 最后更新时间，采用 RFC 3339 格式的 UTC 时间。
archived_at string | 归档时间
Environment 首次归档的时间，采用 RFC 3339 格式的 UTC 时间。归档接口成功后返回该字段；重复归档时保持不变。
config object | 环境配置
Environment 当前生效的运行配置。
type string | 环境类型
config.type
Environment 的运行方式。cloud 表示由火山方舟提供运行环境，self_hosted 表示由调用方提供运行环境。
env object | 环境变量
config.env
Environment 运行时使用的环境变量，以字符串键值对形式返回。
networking object | 出网策略
config.networking
Environment 当前生效的出网配置。对于 self_hosted Environment，服务端固定返回 type 为 unrestricted。
type string | 出网策略类型
config.networking.type
Environment 的出网方式。unrestricted 表示不限制出网目标。
packages object | 依赖包配置
config.packages
Environment 启动时预装的依赖包。
apt string[] | apt 包
config.packages.apt
Environment 启动时通过 apt 预装的系统包。
cargo string[] | Cargo 包
config.packages.cargo
Environment 启动时通过 Cargo 预装的 Rust crate。
gem string[] | gem 包
config.packages.gem
Environment 启动时通过 RubyGems 预装的 Ruby 包。
go string[] | go 包
config.packages.go
Environment 启动时通过 Go 工具链预装的模块依赖。
npm string[] | npm 包
config.packages.npm
Environment 启动时通过 npm 预装的 Node.js 包。
pip string[] | pip 包
config.packages.pip
Environment 启动时通过 pip 预装的 Python 包。
type string | 配置类型
config.packages.type
依赖包配置的类型标识。
取值固定为 packages。
setup_script string | 启动脚本
config.setup_script
Environment 启动时执行的初始化脚本。
tos object | 产物存储配置
config.tos
智能体产物的持久化存储位置。
bucket string | TOS 桶
config.tos.bucket
存储智能体产物的 TOS Bucket 名称。
prefix string | 对象前缀
config.tos.prefix
智能体产物在 TOS Bucket 内的基础目录前缀。平台注册 outputs 产物时，会以 {prefix}outputs/{env-id}/{session-id}/ 作为 Files API 写入前缀。
最终对象路径以 Files API 响应中的 tos.object_key 为准，通常还会包含 ark_processed/{file_id}/{file_type}/{filename}。
description string | 环境描述
Environment 的用途说明。
metadata object | 自定义元数据
Environment 的自定义业务属性，以字符串键值对形式返回。
归档环境
发起调试等同于请求真实调用，可能产生云产品费用，请谨慎操作！
Request
cURL
curl -sS --fail-with-body \
"https://ark.cn-beijing.volces.com/api/v3/environments/<ENVIRONMENT_ID>/archive" \
-H "Authorization: Bearer $ARK_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'Response
{
"id": "<ENVIRONMENT_ID>",
"type": "environment",
"name": "<ENVIRONMENT_NAME>",
"config": {
"type": "cloud",
"networking": {
"type": "unrestricted"
}
},
"created_at": "2026-10-20T08:00:00Z",
"updated_at": "2026-10-26T09:20:00Z",
"archived_at": "2026-10-26T09:20:00Z"
}最近更新时间：2026.10.30 21:22:59
这个页面对您有帮助吗？
有用
有用
无用
无用