查询定时任务(QuerySchedulerJob)

API请求

URLs

GET zstack/v1/scheduler/jobs
GET zstack/v1/scheduler/jobs/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl示例

curl -H "Content-Type: application/json" \
-H "Authorization: OAuth b0d89c0878b3492b9f258fcadc81e5f2" \
-X GET http://localhost:8080/zstack/v1/scheduler/jobs?q=name=TestScheduler&q=state=Enabled

curl -H "Content-Type: application/json" \
-H "Authorization: OAuth c50c86041f044014bfdc88f2806d989b" \
-X GET http://localhost:8080/zstack/v1/scheduler/jobs/eb52cb8434bc4929b34097d630043695

可查询字段

运行zstack-cli命令行工具，输入QuerySchedulerJob并按Tab键查看所有可查询字段以及可跨表查询的资源名。

API返回

返回示例

{
  "inventories": [
    {
      "uuid": "346e89a1e0f64ce092fc4541f695151f",
      "targetResourceUuid": "b08f45dbea734a9b9507bb773af28428",
      "name": "test",
      "createDate": "Jul 17, 2017 10:18:54 AM",
      "lastOpDate": "Jul 17, 2017 10:18:54 AM"
    }
  ]
}


名字	类型	描述	起始版本
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	2.1
inventories	List	详情参考inventories	2.1

#error


名字	类型	描述	起始版本
code	String	错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001	2.1
description	String	错误的概要描述	2.1
details	String	错误的详细信息	2.1
elaboration	String	保留字段，默认为null	2.1
opaque	LinkedHashMap	保留字段，默认为null	2.1
cause	ErrorCode	根错误，引发当前错误的源错误，若无原错误，该字段为null	2.1

#inventories


名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	2.1
targetResourceUuid	String		2.1
name	String	资源名称	2.1
description	String	资源的详细描述	2.1
state	String		2.1
createDate	Timestamp	创建时间	2.1
lastOpDate	Timestamp	最后一次修改时间	2.1
triggersUuid	List		2.1

SDK示例

Java SDK

QuerySchedulerJobAction action = new QuerySchedulerJobAction();
action.conditions = asList("name=TestScheduler","state=Enabled");
action.sessionId = "0864c676a4fc4e408dc6d89548e1387f";
QuerySchedulerJobAction.Result res = action.call();

Python SDK

QuerySchedulerJobAction action = QuerySchedulerJobAction()
action.conditions = ["name=TestScheduler","state=Enabled"]
action.sessionId = "a25af40af81541c5b7160af8a135b040"
QuerySchedulerJobAction.Result res = action.call()