qschedule http interface(new)

介绍

使用前提条件：

1.访问接口时job是使用1.0.2及以上版本的client注册的。

如何注册：http://wiki.corp.qunar.com/display/devwiki/qschedule+client#qscheduleclient-

新的接口特点：

1.接口路径以/api2开头
2.访问接口必须传递Q-Server-Token消息头。该消息头从应用中心获得

如何获得Q-Server_Token: http://wiki.corp.qunar.com/pages/viewpage.action?pageId=56427424#2.%E6%A8%A1%E5%9D%97%E5%8A%9F%E8%83%BD-%E5%A6%82%E4%BD%95%E8%AE%BF%E9%97%AE

3.请求参数中不需要再传递老token

启用job接口

URL: /api2/jobs/on.do
HEADER:

Q-Server-Token :"IGbpF3fyuEVyzkNKuwZZESxPx3IhsHm5LnUSM1..."

METHOD: POST
BODY:

{
"jobs":["qschedule.demo.job1","qschedule.demo.job2"]
}

RESPONSE:

1.{"ret":false,"message":"参数错误"}
2.{"ret":false, "message":"授权失败"}
3.{"ret":false,"message":"启用失败"}
4.{"ret":true,"message":"操作成功"}

禁用job接口

URL: /api2/jobs/off.do
HEADER:

Q-Server-Token :"IGbpF3fyuEVyzkNKuwZZESxPx3IhsHm5LnUSM1..."

METHOD: POST
BODY:

{
"jobs":["qschedule.demo.job1","qschedule.demo.job2"]
}

RESPONSE:

1.{"ret":false,"message":"参数错误"}
2.{"ret":false, "message":"授权失败"}
3.{"ret":false,"message":"停止失败"}
4.{"ret":true,"message":"操作成功"}

查询job信息接口

URL: /api2/jobs/$job_name.do
HEADER:

Q-Server-Token :"IGbpF3fyuEVyzkNKuwZZESxPx3IhsHm5LnUSM1..."

METHOD: GET

RESPONSE:

1.{"ret":false,"message":"参数错误"}
2.{"ret":false, "message":"授权失败"}
3.{"ret":false,"message":"job不存在"}
4.{"ret":false, "message":"查询失败"}
5. {"data":{
       "appId":163, 
       "appName":"qschedule.demo", 
       "lastRun":1402545989000, 
       "lastState":0, 
       "name":"qschedule.demo.job1_dev", 
       "recover":"discard", 
       "state":false, 
       "type":"remote"},
    "ret":true}

立即执行任务接口

URL: /api2/tasks.do
HEADER:

Q-Server-Token :"IGbpF3fyuEVyzkNKuwZZESxPx3IhsHm5LnUSM1..."

METHOD: POST
BODY:

{
"job":"qschedule.demo.job1",
"param":{}
}

RESPONSE:

1.{"ret":false,"message":"参数错误"}
2.{"ret":false, "message":"授权失败"}
3.{"ret":false,"message":"重试失败"}
4.{"ret":false, "message":"内部错误"}
5. {"ret":true,"message":"140727.123745.192.168.236.130.26859.2531970"}

Worker上下线接口

URL: /api2/workers/state.do
HEADER:

Q-Server-Token :"IGbpF3fyuEVyzkNKuwZZESxPx3IhsHm5LnUSM1..."

METHOD: POST
BODY:

{
        "jobName":"qschedule.demo.job1",
        "workers":'{"192.168.1.1:20010":true,"192.168.1.2:20010":false}'
 }

RESPONSE:

1.{"ret":false,"message":"参数错误"}
2.{"ret":false, "message":"授权失败"}
3.{"ret":false,"message":"workers json 格式非法"}
4.{"ret":false,"message":"所有机器不能全部下线"}
5.{"ret":false,"message":"可能存在未操作成功的机器，请调用查看接口验证"}
6.{"ret":false,"message":"操作失败"}
7.{"ret":true,"message":"操作成功"}

Worker上下线查询接口

URL: /api2/workers/$job_name.do
HEADER:

Q-Server-Token :"IGbpF3fyuEVyzkNKuwZZESxPx3IhsHm5LnUSM1..."

METHOD: GET
RESPONSE:

1.{"ret":false,"message":"参数错误"}
2.{"ret":false, "message":"授权失败"}
3.{"ret":false,"message":"job不存在"}
4.{"ret":false, "message":"查询失败"}
5.{"data":[
           {"address":"192.168.1.1:20010","canSchedule":true,"hostname":"192.168.1.1:20010","jobName":"qschedule.demo.job1"}
  ],"ret":true}

检查是否有任务在执行接口

URL: /api/check/$ip.do

METHOD: GET

RESPONSE:

1.{"ret":false,"message":"参数错误"}
2.{"ret":false, "message":"查询失败"}
3.{"data":[
	{"appId":233,"appName":"m_car_coupon_dis_entity","consecutiveFailTimesAlertThreshold":1,"cron":"0 30 9 * * ?","desc":"发送即将过期短信","lastDuration":26249000,"lastRun":1423704600000,"lastState":200,"lastUpdate":1423730849000,"loadBalance":"random","name":"car.coupon.sendOutdateMsg","nextRun":1423791000000,"recover":"retry","state":true,"timeout":0,"type":"remote"},
	{"appId":233,"appName":"m_car_coupon_dis_entity","consecutiveFailTimesAlertThreshold":1,"cron":"0 0 1 * * ?","desc":"","lastDuration":56849000,"lastRun":1423674000000,"lastState":200,"lastUpdate":1423730849000,"loadBalance":"random","name":"car.coupon.execOutdate","nextRun":1423760400000,"recover":"retry","state":true,"timeout":0,"type":"remote"}
  ],"ret":true}