iPolloWork Docs

Worker 和连接器

理解托管 Worker 生命周期接口,以及将外部系统接入组织时使用的连接器图谱。

Worker 和连接器是两套不同系统。Worker 运行或代表远程 iPolloWork 运行时;连接器则描述外部账号、实例、目标、映射、发现和同步事件。

异步边界不要将请求已接收当作工作已完成

Worker 创建、发现和同步都需要使用返回的资源 ID 进行后续读取。

  1. 01创建或选择

    创建 Worker 或连接器资源,或选择已有的范围化对象。

  2. 02保存 ID

    保存返回的 Worker、Account、Instance、Target 或 Sync Event 标识。

  3. 03观察

    通过匹配路由读取活动、Runtime、发现、Mapping 或同步状态。

  4. 04窄范围重试

    在归属边界修复问题,只重试具体失败操作,不重复创建资源。

托管 Worker

/v1/workers 资源族提供 Worker 记录与运行子资源:

/v1/workers
/v1/workers/{id}
/v1/workers/{id}/activity-heartbeat
/v1/workers/{id}/runtime
/v1/workers/{id}/runtime/upgrade
/v1/workers/{id}/tokens

只有部署了托管 Worker 或组织管理 Worker 时才需要调用这些接口。普通本地桌面工作区不需要通过 Cloud Worker 生命周期接口完成日常工作。

连接器图谱

层级API 资源族含义
账号/v1/connector-accounts已授权的外部身份或连接账号。
实例/v1/connector-instances包含启用、停用、发现和目标的连接器配置。
目标/v1/connector-targets可包含映射和重新同步活动的外部作用范围。
映射/v1/connector-mappings导入或同步资源表示之间的关系。
同步事件/v1/connector-sync-events可观察的同步任务与重试状态。

GitHub 连接器在 /v1/connectors/github/* 下提供独立的配置、安装、账号、仓库和验证接口,并使用 /v1/webhooks/connectors/github 作为 webhook 入口。

操作顺序

  1. 建立并验证外部账号。
  2. 创建或配置连接器实例。
  3. 在应用导入或同步选择前发现可用目标。
  4. 存储映射并观察同步事件。
  5. 仅重试具体失败的同步事件,不要重复创建连接。

准确请求体、webhook 校验、分页、错误响应和版本字段请使用当前 OpenAPI 合约。

完整 Worker 就绪路径与 GitHub Webhook 边界见 运行时、Worker 与 Webhook