跳转到主要内容
GET /v1/environments 列出当前账户下的环境,支持游标分页。默认不返回已归档环境。

请求头

头部必选说明
AuthorizationBearer <PAT>

查询参数

参数类型必选默认值说明
limitinteger20每页返回数量,必须为正整数;超过 100 时按 100 处理
after_idstring-游标分页,按当前 ID 降序返回此 ID 之后的记录。不能与 before_id 同时传
before_idstring-游标分页,按当前 ID 降序返回此 ID 之前的记录。不能与 after_id 同时传
include_archivedbooleanfalse设为 true 时包含已归档环境
created_at[gte]string-仅返回创建时间大于或等于该 RFC 3339 时间戳的环境
created_at[lte]string-仅返回创建时间小于或等于该 RFC 3339 时间戳的环境
完整分页规范详见 分页

示例请求

curl -s -X GET "https://api.qoder.com/api/v1/cloud/environments" \
  -H "Authorization: Bearer $QODER_PAT"

示例响应

HTTP 200 OK
{
  "data": [
    {
      "id": "env_019e3bb39b6774d8878cd0b9d237574b",
      "type": "environment",
      "name": "doc-test-env",
      "description": "",
      "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:07.017808Z"
    },
    {
      "id": "env_019e2590d33f711fabf42f2857cecd8a",
      "type": "environment",
      "name": "default",
      "description": "",
      "status": "ready",
      "config": {
        "type": "cloud",
        "networking": {
          "type": "limited"
        },
        "packages": {}
      },
      "metadata": {},
      "archived": false,
      "archived_at": null,
      "created_at": "2026-05-14T08:18:28.800813Z",
      "updated_at": "2026-05-14T08:18:28.800813Z"
    }
  ],
  "first_id": "env_019e3bb39b6774d8878cd0b9d237574b",
  "has_more": false,
  "last_id": "env_019e2590d33f711fabf42f2857cecd8a"
}

响应字段

字段类型说明
dataEnvironment 对象数组当前页的 Environment
first_idstring当前页第一条记录的 ID
last_idstring当前页最后一条记录的 ID
has_moreboolean是否还有更多数据可供翻页

错误码

HTTPtype说明
400invalid_request_errorlimit 不是正整数
400invalid_request_error同时传入了 before_idafter_id
400invalid_request_errorcreated_at[gte]created_at[lte] 不是 RFC 3339 时间
401authentication_error认证失败,PAT 无效或过期
403permission_error无权访问此资源

注意事项

  • 默认按 ID 降序排列
  • 已归档的 Environment 不会出现在默认列表中;传 include_archived=true 可包含已归档 Environment
  • 使用游标分页,不支持 offset 方式

相关

云端环境

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