POST https://ark.cn-beijing.volces.com/api/v3/environments/{environment_id}
更新指定 Environment 的描述、运行配置或自定义元数据。
鉴权#
本接口支持鉴权方式如下，详情请参见 Base URL 及鉴权。
- API Key 鉴权，请在 API Key 管理 页面，获取长效 API Key。
请求参数#
Path 参数#
environment_id string 必选 | 环境 ID
要更新的 Environment ID，以 env- 开头。可从创建环境或查询环境列表接口的响应中获取。
Body 参数#
config object | 环境配置
指定需要更新的 Environment 运行配置。
env object | 环境变量
config.env
Environment 运行时使用的环境变量，以变量名和变量值组成的字符串键值对形式传入。
networking object | 出网策略
config.networking
Environment 的出网配置。
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 内的目录前缀。最终对象 key 形如 {prefix}outputs/{env-id}/{session-id}/{file}。
type string | 环境类型
config.type
Environment 的运行方式。cloud 表示由火山方舟提供运行环境，self_hosted 表示由调用方提供运行环境。
description string | 环境描述
用于说明 Environment 的用途，最长 300 个字符。省略或传 null 时保留原值，传空字符串 "" 时清空。
metadata object | 自定义元数据
用于记录 Environment 的业务属性，以字符串键值对形式传入，便于关联和管理资源。
name string | 环境名称
Environment 的名称。该字段仅用于兼容回传当前值；Environment 名称创建后不可修改，传入不同名称时服务端返回 HTTP 409 Conflict。
响应参数#
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 时间。
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 内的目录前缀。最终对象 key 形如 {prefix}outputs/{env-id}/{session-id}/{file}。
description string | 环境描述
Environment 的用途说明。
metadata object | 自定义元数据
Environment 的自定义业务属性，以字符串键值对形式返回。