ManagingSchedulers
本文档涵盖调度器的生命周期:创建(含元数据)、列表(含搜索和过滤)、更新配置、运行状况监控和删除。
创建调度器
使用显示名称创建新的调度器:
1curl -X POST "https://api.hola.cloud/schedulers" \
2 -H "X-API-Key: YOUR_API_KEY" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "display_name": "email-scheduler"
6 }'
1POST /schedulers HTTP/1.1
2Host: api.hola.cloud
3X-API-Key: YOUR_API_KEY
4Content-Type: application/json
5
6{
7 "display_name": "email-scheduler"
8}
预期响应:
1{
2 "id": "sched-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
3 "display_name": "email-scheduler",
4 "ready": true,
5 "scheduled": 0,
6 "inflight": 0
7}
列出调度器
列出您账户中的所有调度器(公共):
1curl "https://api.hola.cloud/schedulers"
1GET /schedulers HTTP/1.1
2Host: api.hola.cloud
预期响应:
1[
2 {
3 "id": "sched-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
4 "display_name": "email-scheduler",
5 "ready": true,
6 "scheduled": 5,
7 "inflight": 0
8 },
9 {
10 "id": "sched-b2c3d4e5-f6a7-8901-bcde-f12345678901",
11 "display_name": "report-generator",
12 "ready": true,
13 "scheduled": 0,
14 "inflight": 0
15 }
16]
获取调度器详情
通过ID检索单个调度器:
1curl "https://api.hola.cloud/schedulers/sched-a1b2c3d4-e5f6-7890-abcd-ef1234567890"
1GET /schedulers/sched-a1b2c3d4-e5f6-7890-abcd-ef1234567890 HTTP/1.1
2Host: api.hola.cloud
预期响应:
1{
2 "id": "sched-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
3 "display_name": "email-scheduler",
4 "ready": true,
5 "scheduled": 5,
6 "inflight": 0
7}
更新调度器
更新显示名称或其他元数据:
1curl -X PATCH "https://api.hola.cloud/schedulers/sched-a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
2 -H "X-API-Key: YOUR_API_KEY" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "display_name": "email-scheduler-v2"
6 }'
1PATCH /schedulers/sched-a1b2c3d4-e5f6-7890-abcd-ef1234567890 HTTP/1.1
2Host: api.hola.cloud
3X-API-Key: YOUR_API_KEY
4Content-Type: application/json
5
6{
7 "display_name": "email-scheduler-v2"
8}
预期响应:
1{
2 "id": "sched-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
3 "display_name": "email-scheduler-v2",
4 "ready": true,
5 "scheduled": 5,
6 "inflight": 0
7}
PUT可以与PATCH互换使用。
运行状况监控
随时检查调度器的运行状态:
1curl "https://api.hola.cloud/schedulers/sched-a1b2c3d4-e5f6-7890-abcd-ef1234567890/health"
1GET /schedulers/sched-a1b2c3d4-e5f6-7890-abcd-ef1234567890/health HTTP/1.1
2Host: api.hola.cloud
预期响应:
1{
2 "status": "ok",
3 "ready": true,
4 "scheduled": 0,
5 "inflight": 0,
6 "scheduler_id": "sched-a1b2c3d4-e5f6-7890-abcd-ef1234567890"6
7}
非ok状态表示调度器不可用或处于降级状态。
删除调度器
永久删除调度器及其所有任务:
1curl -X DELETE "https://api.hola.cloud/schedulers/sched-a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
2 -H "X-API-Key: YOUR_API_KEY"
1DELETE /schedulers/sched-a1b2c3d4-e5f6-7890-abcd-ef1234567890 HTTP/1.1
2Host: api.hola.cloud
3X-API-Key: YOUR_API_KEY
预期响应:HTTP 204 No Content。
删除后,调度器ID将不再有效,所有待处理任务将被丢弃。
评论