归档指定环境。归档后不可再用于创建新会话。
无需请求体。
HTTP 200 OK
POST /api/v1/cloud/environments/{environment_id}/archive
归档指定环境。归档后会设置 archived_at,不可再用于创建新会话,但已关联的会话不受影响。
请求头
| 头部 | 必选 | 说明 |
|---|---|---|
Authorization | 是 | Bearer <PAT> |
路径参数
| 参数 | 类型 | 必选 | 说明 |
|---|---|---|---|
environment_id | string | 是 | 环境的唯一标识(前缀为 env_) |
请求体
无需请求体。
示例请求
示例响应
HTTP 200 OK
响应字段
| 字段 | 类型 | 说明 |
|---|---|---|
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 的环境不存在 |
注意事项
- 归档操作是幂等的,重复归档不会报错