GET https://ark.cn-beijing.volces.com/api/v3/environments
查询当前项目下可用的 Environment 列表。
鉴权#
本接口支持鉴权方式如下，详情请参见 Base URL 及鉴权。
- API Key 鉴权，请在 API Key 管理 页面，获取长效 API Key。
请求参数#
Query 参数#
在 URL Query String 中传入。
limit integer 默认值 20 | 每页数量
控制单次请求返回的 Environment 数量。
取值范围：[1, 100]
page string | 下一页标识
用于继续查询下一页。首次请求省略；后续请求原样传入上一次响应的 next_page。
响应参数#
data object[] | 环境列表
本次请求返回的 Environment 列表，服务端按创建时间降序排列。
created_at string | 创建时间
data.created_at
Environment 创建时间，采用 RFC 3339 格式的 UTC 时间。
id string | 环境 ID
data.id
Environment ID，由服务端生成，以 env- 开头。
name string | 环境名称
data.name
Environment 的名称。
type string | 对象类型
data.type
对象类型，固定为 environment。
updated_at string | 更新时间
data.updated_at
Environment 最后更新时间，采用 RFC 3339 格式的 UTC 时间。
config object | 环境配置
data.config
Environment 当前生效的运行配置。
type string | 环境类型
data.config.type
Environment 的运行方式。cloud 表示由火山方舟提供运行环境，self_hosted 表示由调用方提供运行环境。
env object | 环境变量
data.config.env
Environment 运行时使用的环境变量，以字符串键值对形式返回。
networking object | 出网策略
data.config.networking
Environment 当前生效的出网配置。对于 self_hosted Environment，服务端固定返回 type 为 unrestricted。
type string | 出网策略类型
data.config.networking.type
Environment 的出网方式。unrestricted 表示不限制出网目标。
packages object | 依赖包配置
data.config.packages
Environment 启动时预装的依赖包。
apt string[] | apt 包
data.config.packages.apt
Environment 启动时通过 apt 预装的系统包。
cargo string[] | Cargo 包
data.config.packages.cargo
Environment 启动时通过 Cargo 预装的 Rust crate。
gem string[] | gem 包
data.config.packages.gem
Environment 启动时通过 RubyGems 预装的 Ruby 包。
go string[] | go 包
data.config.packages.go
Environment 启动时通过 Go 工具链预装的模块依赖。
npm string[] | npm 包
data.config.packages.npm
Environment 启动时通过 npm 预装的 Node.js 包。
pip string[] | pip 包
data.config.packages.pip
Environment 启动时通过 pip 预装的 Python 包。
type string | 配置类型
data.config.packages.type
依赖包配置的类型标识。
取值固定为 packages。
setup_script string | 启动脚本
data.config.setup_script
Environment 启动时执行的初始化脚本。
tos object | 产物存储配置
data.config.tos
智能体产物的持久化存储位置。
bucket string | TOS 桶
data.config.tos.bucket
存储智能体产物的 TOS Bucket 名称。
prefix string | 对象前缀
data.config.tos.prefix
智能体产物在 TOS Bucket 内的目录前缀。最终对象 key 形如 {prefix}outputs/{env-id}/{session-id}/{file}。
description string | 环境描述
data.description
Environment 的用途说明。
metadata object | 自定义元数据
data.metadata
Environment 的自定义业务属性，以字符串键值对形式返回。
next_page string | 下一页标识
下一页标识。无更多数据时不返回该字段。