创建 Environment

更新时间:
复制为 MD 格式

创建一个新的云端执行环境,用于托管 Agent 会话。

请求头

头部

必选

说明

Authorization

Bearer <PAT>

Content-Type

application/json

请求体

字段

类型

必选

说明

name

string

环境名称,用于标识该环境

description

string

环境描述

config

object

环境配置对象

config.type

string

固定值 "cloud"

config.networking

object

网络访问配置

config.networking.type

string

网络类型:"unrestricted"(无限制)、"limited"(受限)、"allowed_hosts"(白名单)

config.networking.allowed_hosts

array

允许访问的主机列表(仅 allowed_hosts 类型需要)

config.networking.allow_package_managers

boolean

是否允许包管理器联网

config.packages

object

预装软件包配置

config.packages.apt

array

需要预装的 apt 包列表

config.packages.pip

array

需要预装的 pip 包列表

config.packages.npm

array

需要预装的 npm 包列表

metadata

object

自定义元数据键值对

示例请求

curl -s -X POST "https://api.qoder.com.cn/api/v1/cloud/environments" \
  -H "Authorization: Bearer $QODER_PAT" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "doc-test-env",
    "config": {
      "type": "cloud",
      "networking": {
        "type": "limited"
      },
      "packages": {
        "apt": ["curl"]
      }
    }
  }'

示例响应

HTTP 201 Created

{
  "id": "env_019e3bb39b6774d8878cd0b9d237574b",
  "type": "environment",
  "name": "doc-test-env",
  "description": "",
  "status": "ready",
  "config": {
    "type": "cloud",
    "networking": {
      "type": "limited"
    },
    "packages": {
      "apt": ["curl"]
    }
  },
  "archived": false,
  "archived_at": null,
  "created_at": "2026-05-18T15:28:07.017808Z",
  "updated_at": "2026-05-18T15:28:07.017808Z"
}

响应字段

字段

类型

说明

id

string

环境唯一标识,前缀为 env_

type

string

资源类型,固定值 "environment"

name

string

环境名称

description

string

环境描述

status

string

环境状态(如 "ready"

config

object

环境配置

archived

boolean

是否已归档

archived_at

string|null

归档时间(ISO 8601),未归档时为 null

created_at

string

创建时间(ISO 8601 格式)

updated_at

string

最后更新时间(ISO 8601 格式)

错误码

HTTP

type

说明

400

invalid_request_error

请求参数无效(如缺少 config.type 字段)

401

authentication_error

认证失败,PAT 无效或过期

403

permission_error

无权执行此操作

409

conflict_error

同名环境已存在