跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://docs.qoder.com/llms.txt

Use this file to discover all available pages before exploring further.

POST /v1/environments/{environment_id}/archive 归档指定环境。归档后环境状态变为 "archived",不可再用于创建新会话,但已关联的会话不受影响。

请求头

头部必选说明
AuthorizationBearer <PAT>

路径参数

参数类型必选说明
environment_idstring环境的唯一标识(前缀为 env_

请求体

无需请求体。

示例请求

curl -s -X POST "https://openapi.qoder.sh/api/v1/cloud/environments/env_019e3bb39b6774d8878cd0b9d237574b/archive" \
  -H "Authorization: Bearer $QODER_PAT"

示例响应

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

响应字段

字段类型说明
idstring环境唯一标识
typestring资源类型,固定值 "environment"
namestring环境名称
descriptionstring环境描述
statusstring环境状态,归档后为 "archived"
configobject环境配置
created_atstring创建时间(ISO 8601 格式)
updated_atstring归档操作的时间(ISO 8601 格式)

错误码

HTTPtype说明
401authentication_error认证失败,PAT 无效或过期
403permission_error无权访问此资源
404not_found_error指定 ID 的环境不存在
409conflict_error环境已经处于归档状态