EdgeCron API Docs

EdgeCron API 文档

用于定时 HTTP、事件触发、Webhook 投递、重试和订阅用量的开发者文档。

EdgeCron API 让你通过签名请求创建调度触发、发布业务事件、管理 Webhook 回调端点,并追踪每一次投递尝试。

公开接口

36

API 分组

7

源文件

OpenAPI 3.0.3

回调端点

01

触发来源

02

执行任务

03

投递尝试

04

重试任务

05

死信

06

一分钟理解 EdgeCron

Endpoint / 回调端点

投递到哪里

目标 Webhook 地址。它包含回调 URL、方法、请求头、超时、可选签名密钥、重试策略绑定和事件订阅。

Schedule Trigger / 调度触发

什么时候投递

cron 或一次性时间规则。它到点后创建 Task Run;它本身不会直接发起 HTTP 请求。

Event Trigger / 事件触发

为什么投递

命名业务事件,例如 invoice.paid。Endpoint 过滤规则决定哪些目标接收事件,然后 fan-out 创建 Task Run。

Task Run / 执行任务

一次执行实例

由调度、事件 fan-out 或直接 API 调用创建的运行时工作。用于跟踪状态或取消待执行任务。

Delivery Attempt / 投递尝试

一次 HTTP 调用

对 Endpoint 的一次出站请求。它记录状态码、耗时、响应摘要、错误信息、尝试次数和 trace 信息。

Retry Job / 重试任务

一次恢复任务

由可重试的失败投递创建的队列任务。重试策略控制最大尝试次数和退避方式。

从触发到死信

01

回调端点

配置 EdgeCron 要调用哪里:URL、方法、请求头、超时、签名密钥、重试策略和事件过滤。

02

触发来源

调度触发、事件发布或直接 API 调用决定为什么以及什么时候开始执行。

03

执行任务

EdgeCron 创建一个绑定 Endpoint 和 payload 的具体运行实例。

04

投递尝试

Worker 发起 HTTP 调用,并记录状态、耗时、响应内容和 request_id。

05

重试任务

可重试失败会根据策略进入固定、线性或指数退避队列。

06

死信

超过最大尝试次数的失败会保留为死信,等待人工检查、重放或补偿。

基础地址

https://api.edgecron.com/v1

开发环境默认地址:

http://localhost:8888/v1

下一步

本页目录