归档 Environment

更新时间:
复制 MD 格式

归档指定环境。归档后不可再用于创建新会话。

POST /api/v1/cloud/environments/{environment_id}/archive

归档指定环境。归档后会设置 archived_at,不可再用于创建新会话,但已关联的会话不受影响。

请求头

头部

必选

说明

Authorization

Bearer <PAT>

路径参数

参数

类型

必选

说明

environment_id

string

环境的唯一标识(前缀为 env_

请求体

无需请求体。

示例请求

curl -s -X POST "https://api.qoder.com.cn/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 文档测试的环境",
  "config": {
    "type": "cloud",
    "networking": {
      "type": "limited",
      "allowed_hosts": [],
      "allow_package_managers": false,
      "allow_mcp_servers": false
    },
    "packages": {
      "type": "packages",
      "apt": ["curl"],
      "npm": [],
      "pip": []
    }
  },
  "metadata": {},
  "archived_at": "2026-05-18T15:28:08.459536Z",
  "created_at": "2026-05-18T15:28:07.017808Z",
  "updated_at": "2026-05-18T15:28:08.459536Z"
}

响应字段

字段

类型

说明

id

string

环境唯一标识

type

string

资源类型,固定值 "environment"

name

string

环境名称

description

string

环境描述

config

Environment config

Environment 配置

metadata

Metadata 对象

自定义元数据

archived_at

string|null

归档时间(ISO 8601)

created_at

string

创建时间(ISO 8601 格式)

updated_at

string

归档操作的时间(ISO 8601 格式)

错误码

HTTP

type

说明

401

authentication_error

认证失败,PAT 无效或过期

403

permission_error

无权访问此资源

404

not_found_error

指定 ID 的环境不存在

注意事项

  • 归档操作是幂等的,重复归档不会报错