更新 Environment

更新指定环境的属性，如名称、描述、配置等。

PUT /v1/environments/{environment_id}

更新指定环境的属性（如名称、描述、配置等）。

​

请求头

头部	必选	说明
Authorization	是	Bearer <PAT>
Content-Type	是	application/json

​

路径参数

参数	类型	必选	说明
environment_id	string	是	环境的唯一标识（前缀为 env_）

​

请求体

仅需传入要更新的字段，未传入的字段保持不变。

字段	类型	必选	说明
name	string	否	环境名称
description	string	否	环境描述
config	Environment config	否	替换已保存的 Environment 配置
metadata	Metadata 对象	否	Metadata 补丁；字段会合并到已保存的 metadata，value 必须是 string

​

示例请求

curl -s -X PUT "https://api.qoder.com/api/v1/cloud/environments/env_019e3bb39b6774d8878cd0b9d237574b" \
  -H "Authorization: Bearer $QODER_PAT" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "用于 API 文档测试的环境"
  }'

​

示例响应

HTTP 200 OK

{
  "id": "env_019e3bb39b6774d8878cd0b9d237574b",
  "type": "environment",
  "name": "doc-test-env",
  "description": "用于 API 文档测试的环境",
  "status": "ready",
  "config": {
    "type": "cloud",
    "networking": {
      "type": "limited"
    },
    "packages": {
      "apt": ["curl"]
    }
  },
  "metadata": {},
  "archived": false,
  "archived_at": null,
  "created_at": "2026-05-18T15:28:07.017808Z",
  "updated_at": "2026-05-18T15:28:08.093156Z"
}

​

响应字段

字段	类型	说明
id	string	环境唯一标识
type	string	资源类型，固定值 "environment"
name	string	环境名称
description	string	更新后的描述
status	string	环境状态
config	Environment config	Environment 配置
metadata	Metadata 对象	自定义元数据
archived	boolean	是否已归档
archived_at	string|null	归档时间（ISO 8601），未归档时为 null
created_at	string	创建时间（ISO 8601 格式）
updated_at	string	最后更新时间（已更新为最新时间）

​

错误码

HTTP	type	说明
400	invalid_request_error	请求体、config 或 metadata 字段值不合法
401	authentication_error	认证失败，PAT 无效或过期
403	permission_error	无权访问此资源
404	not_found_error	指定 ID 的环境不存在

​

注意事项

• 未传入的字段保持不变
• 显式传入 config 时，会用请求中的配置整体替换已保存的配置
• 显式传入 metadata 时，请求中的 key 会合并到已保存的 metadata 对象

​

相关

云端环境

选择 Agent 运行的容器、网络与依赖。