修改 Environment

描述

通过 POST 修改 Environment 的配置和展示信息。

路径

POST /api/v1/forward/environments/{id}

请求头

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

路径参数

参数	类型	必选	说明
`id`	string	是	Environment ID。

查询参数

参数	类型	必选	说明
`identity_id`	string	否	仅在操作 Identity 归属资源时使用，非必填；PAT 场景可显式传入，未传时为管理员视角；SAT 场景请签发 Identity 维度凭证且不要显式携带该参数，否则返回 HTTP 400（详见 Identity 归属）。

请求体

字段	类型	必选	说明
`name`	string	否	新名称。
`description`	string	否	新描述。
`config`	Environment config	否	新配置；传入时不能为 `null`，显式 `null` 返回 400。字段详见 schemas。
`metadata`	object	否	要合并的 Environment metadata；传入时不能为 `null`，显式 `null` 返回 400。

示例请求

curl -X POST "https://api.qoder.com.cn/api/v1/forward/environments/env_xxx" \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"dev-env-updated"}'

示例响应

HTTP 200 OK

{
  "id": "env_xxx",
  "type": "environment",
  "name": "dev-env",
  "description": "Development environment",
  "config": {"type": "cloud"},
  "metadata": {"source": "console"},
  "created_at": "2026-07-23T10:00:00Z",
  "updated_at": "2026-07-23T10:00:00Z",
  "identity_id": null
}

响应字段

响应为 Environment 对象。

错误码

HTTP	type	触发条件
400	`invalid_request_error`	请求体、路径参数或查询参数非法；或 SAT 携带了 `identity_id`。
400	`invalid_request_error`	传入保留键 `created_by` 时，`message` 为 `metadata key "created_by" is reserved`，可据此定位到具体字段。
401	`authentication_error`	缺少或无效的认证令牌。
403	`permission_error`	未指定 `identity_id` 的 PAT、Admin SAT 发生 Owner mismatch，或当前调用方存在其他权限不足。
404	`not_found_error`	资源不存在或不可见；或 `identity_id` 无效、已禁用、不属于当前调用方；或该资源不属于当前 Identity 归属。
500/502/503	`api_error`	Forward 或依赖服务失败。

​描述

​路径

​请求头

​路径参数

​查询参数

​请求体

​示例请求

​示例响应

​响应字段

​错误码

描述

路径

请求头

路径参数

查询参数

请求体

示例请求

示例响应

响应字段

错误码