Webhook
- 针对Cube的部分异步API,Cube平台提供了Webhook方式的异步回调通知功能,即当您请求异步API成功后,无需再主动轮询响应结果,Cube平台会主动将响应结果推送至您配置的URL Address中。
- 在使用此功能前,请确保您已经获取了Notification Key,获取方法如下:
- Notification Key可在创建API Key(如何获取API Key)后自动创建。
- 在[Cube-Autoflow]中创建了API类的自动化规则,详情可查看Cube使用文档。
- 当拥有Notification Key后,可在[Cube-开发者-Webhook Settings]模块查看Notification Key。
4. 获取Notification Key后可在[Cube-开发者-Webhook Settings]的[webhooks]模块填写您想要接收异步API回调通知的URL Address ,此URL仅支持HTTPS。
5. URL Address填写并保存成功后,[Webhooks feature status]默认为[Enable]状态,您将能正常接收到所有由您发起的异步API请求的回调通知。
1. 您可以将[Webhooks feature status]设置为[Disable]状态,Cube将立即停止发送一切与由您发起的异步API请求的回调通知。
2. 这些通知如果发送失败,会在24小时内最多会重新发送30次,如果仍未成功,则不再发送。
6. 您可以在[Cube-开发者-Notification Logs]模块查看这些异步API请求的回调通知记录,每次自动重新发送都会生成一条记录。
7. 支持回调通知的所有异步API,其[事件类型]统一为[异步API回调通知]([Async API callback notification ]),[事件子类型]如下表所示:
事件子类型 | Event sub-type | 异步API |
---|---|---|
激活(异步) | Activate (Async) | https://api.linksfield.net/cube/v4/sims/{sim_id}/activate |
停机v2(异步) | Suspend v2 (Async) | https://api.linksfield.net/cube/v4/sims/{sim_id}/suspend/v2 |
复机(异步) | Resume (Async) | https://api.linksfield.net/cube/v4/sims/{sim_id}/resume |
重置(异步) | Reset (Async) | https://api.linksfield.net/cube/v4/sims/{sim_id}/reset |
非OTA更换套餐 | Non-OTA Package Change | https://api.linksfield.net/cube/v4/sims/{sim_id}/bundle |
取消(异步) | Cancel (Async) | https://api.linksfield.net/cube/v4/sims/{sim_id}/cancel |
恢复(异步) | Restore (Async) | https://api.linksfield.net/cube/v4/sims/{sim_id}/restore |
恢复初始设置 | Restore to initial settings | https://api.linksfield.net/cube/v4/sims/{sim_id}/reinitialize |
选择并锁定本地网络 | Select and lock the local network | https://api.linksfield.net/cube/v4/sims/{sim_id}/selected_local_operators |
- Cube的重试策略简单的概括为:第一次间隔1分钟,后续按指数递增,直到超过60分钟。超过60分钟后按60分钟一次重试,重试次数最大30次。
重试次数 | 与上次间隔(分) | 距离开始推送时间(分) |
---|---|---|
1 | 1 | 1 |
2 | 2 | 3 |
3 | 4 | 7 |
4 | 8 | 15 |
5 | 18 | 31 |
6 | 32 | 63 |
7-30 | 60 | ... |
最后修改时间: 1 天前