全部产品
云市场

定时任务

更新时间:2019-09-20 20:47:33

查询任务信息列表

功能描述

查询定时任务资源集合,支持分页查询。

接口定义

接口
/sofa/ms/dss/jobs
Method
GET
type
json
参数
字段
类型
必须
描述
instance_id
String
Y
租户 ID
例如: abcdEFGH1234
app
String
任务所属APP
name
String
任务名字
page_num
Integer
Y
当前页数,默认值1
page_size
Integer
每页显示数量,默认值10
响应
type: application/json
字段
类型
必填
描述
result_code
String
Y
结果码,OK 表示成功
result_msg
String
结果码描述
req_msg_id
String
Y
请求追踪 ID
jobs
List
Y
任务信息
page_num
Integer
Y
当前页
page_size
Integer
Y
每页显示数量
total_count
Integer
Y
总条数

请求示例

  1. GET /sofa/ms/dss/jobs?instance_id=abcd1234
  2. &app=xxx
  3. &name=xxx
  4. &page_num=3&page_size=10

响应示例

  1. {
  2. "jobs":
  3. "[
  4. {
  5. "id":"12345678",
  6. "instance_id":"1234abcd",
  7. "app":"所属APP",
  8. "name":"任务名字",
  9. "cron":"Cron 表达式",
  10. "sharding_count":"任务分片数量",
  11. "custom_params":"自定义参数,格式为字符串数组['key1=value1','key2=value2']",
  12. "status":"任务状态",
  13. "des":"任务描述",
  14. "creation_time":"2018-04-16T00:01:59Z",
  15. "update_time":"2018-04-16T00:01:59Z"
  16. }
  17. ]",
  18. "page_num": 1,
  19. "page_size": 10,
  20. "total_count": 29,
  21. "req_msg_id":"1234abcd",
  22. "result_code":"OK",
  23. "result_msg":"Success",
  24. }

查询指定任务信息

功能描述

查询指定 ID 所对应的定时任务元数据。

接口定义

接口
/sofa/ms/dss/jobs/{id}
Method
GET
type
json
参数
字段
类型
必须
描述
instance_id
String
Y
租户 ID
id
Integer
​Y
任务 ID
响应
type: application/json
字段
类型
必填
描述
result_code
String
Y
结果码,OK 表示成功
result_msg
String
结果码描述
req_msg_id
String
Y
请求追踪 ID
job
Job
任务信息

请求示例

  1. GET /sofa/ms/dss/jobs/12345678?instance_id=abcd1234

响应示例

成功响应示例:

  1. {
  2. "job":
  3. {
  4. "id":"12345678",
  5. "instance_id":"1234abcd",
  6. "app":"所属APP",
  7. "name":"任务名字",
  8. "cron":"cron表达式",
  9. "sharding_count":"任务分片数量",
  10. "custom_params":"自定义参数,格式为字符串数组['key1=value1','key2=value2']",
  11. "status":"任务状态",
  12. "des":"任务描述",
  13. "creation_time":"2018-04-16T00:01:59Z",
  14. "update_time":"2018-04-16T00:01:59Z"
  15. }
  16. "req_msg_id":"1234abcd",
  17. "result_code":"OK",
  18. "result_msg":"Success",
  19. }

失败响应数据示例:

  1. {
  2. "result_code":"API_NOT_EXISTS", // API 不存在
  3. "result_msg":"the API (method=sofa.mq.msgtype.query) does not exist",
  4. "req_msg_id":"1234abcd"
  5. }

创建定时任务

功能描述

新增一条定时任务元数据。

接口定义

接口
/sofa/ms/dss/jobs
Method
POST
type
json
参数
字段
类型
必填
描述
instance_id
String
Y
租户
name
String
Y
任务名称
app
String
Y
任务所属 APP
cron
String
Y
任务 Cron 表达式
如:0 0 * * * ?
sharding_count
Integer
任务分片数量,默认1
custom_params
List<String>
任务自定义参数
status
String
状态:
  • RUNNING(启用)
  • STANDBY(禁用)
默认值为 STANDBY。
des
String
任务描述信息
响应
type: application/json
字段
类型
必填
描述
result_code
String
Y
结果码,OK 表示成功
result_msg
String
结果码描述
req_msg_id
String
Y
请求追踪 ID
job
Job
任务信息

请求示例

  1. POST /sofa/ms/dss/jobs
  2. {
  3. "instance_id":"abcd1234",
  4. "app":"xxxx",
  5. "name":"xxx",
  6. "sharding_count":"任务分片数量",
  7. "custom_params":"自定义参数,格式为字符串数组['key1=value1','key2=value2']",
  8. "cron":"Cron 表达式",
  9. "status":"状态,如果不指定默认为‘禁用’",
  10. "des":"描述信息"
  11. }

响应示例

  1. {
  2. "req_msg_id":"1234abcd",
  3. "result_code":"OK",
  4. "result_msg":"Success",
  5. "job":{
  6. "instance_id":"abcd1234",
  7. "id":"1001"
  8. }
  9. }

修改定时任务信息

功能描述

修改指定 ID 所对应的定时任务元数据。

接口定义

接口
/sofa/ms/dss/jobs/{id}
Method
PUT
type
json
参数
字段
类型
必填
描述
instance_id
String
Y
租户 ID
id
Integer
Y
任务 ID
cron
String
Y
任务 Cron 表达式
如:0 0 * * * ?
sharding_count
Integer
任务分片数量
custom_params
List<String>
任务自定义参数
des
String
任务描述信息
响应
type: application/json
字段
类型
必填
描述
result_code
String
Y
结果码,OK 表示成功
result_msg
String
结果码描述
req_msg_id
String
Y
请求追踪 ID
job
Job
任务信息

请求示例

  1. PUT /sofa/ms/dss/jobs/1001
  2. {
  3. "instance_id":"abcd1234",
  4. "cron":"cron表达式",
  5. "sharding_count":"任务分片数量",
  6. "custom_params":"自定义参数,格式为字符串数组['key1=value1','key2=value2']",
  7. "des":"描述信息"
  8. }

响应示例

  1. {
  2. "req_msg_id":"1234abcd",
  3. "result_code":"OK",
  4. "result_msg":"Success",
  5. "job":{
  6. "instance_id":"abcd1234",
  7. "id":"1001"
  8. }
  9. }

修改定时任务状态

功能描述

修改指定 ID 所对应的定时任务的状态。

接口定义

接口
/sofa/ms/dss/status/{id}
Method
PUT
type
json
参数
字段
类型
必填
描述
instance_id
String
Y
租户 ID
id
Integer
Y
任务 ID
status
String
Y
任务状态:
  • RUNNING(启用)
  • STANDBY(禁用)
响应
type: application/json
字段
类型
必填
描述
result_code
String
Y
结果码,OK 表示成功
result_msg
String
结果码描述
req_msg_id
String
Y
请求追踪 ID

请求示例

  1. PUT /sofa/ms/dss/status/111
  2. {
  3. "instance_id":"abcd1234",
  4. "status":"任务状态,RUNNING|STANDBY"
  5. }

响应示例

  1. {
  2. "req_msg_id":"1234abcd",
  3. "result_code":"OK",
  4. "result_msg":"Success"
  5. }

删除定时任务

功能描述

删除一条指定 ID 的定时任务元数据。

接口定义

接口
/sofa/ms/dss/jobs/{id}
Method
DELETE
type
json
参数
字段
类型
必填
描述
instance_id
String
Y
租户 ID
id
Integer
Y
任务 ID
响应
type: application/json
字段
类型
必填
描述
result_code
String
Y
结果码,OK 表示成功
result_msg
String
结果码描述
req_msg_id
String
Y
请求追踪 ID

请求示例

  1. DELETE /sofa/ms/dss/jobs/1111?instance_id=1234abcd

响应示例

  1. {
  2. "req_msg_id":"1234abcd",
  3. "result_code":"OK",
  4. "result_msg":"Success"
  5. }