更新定时任务组

PUT/zstack/v1/scheduler/jobgroups/{uuid}/actions

Request

cURL

curl --request PUT \
  --url '/v1/scheduler/jobgroups/{uuid}/actions' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "status": "ok",
  "method": "PUT",
  "path": "/v1/scheduler/jobgroups/{uuid}/actions"
}

Headers

Authorization: OAuth the-session-uuid

Body

{
  "updateSchedulerJobGroup": {
    "name": "Test2",
    "description": "new test"
  },
  "systemTags": [],
  "userTags": []
}

上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"updateSchedulerJobGroup":{"name":"Test2","description":"new test"}}' http://localhost:8080/zstack/v1/scheduler/jobgroups/4dc1dbf847d733fc98ee2998b5e0eca2/actions

参数列表

名字	类型	位置	描述	可选值	起始版本
uuid	String	url	定时任务组的UUID，唯一标示该资源		3.4.0
name (可选)	String	body(包含在updateSchedulerJobGroup结构中)	资源名称		3.4.0
description (可选)	String	body(包含在updateSchedulerJobGroup结构中)	资源的详细描述		3.4.0
state (可选)	String	body(包含在updateSchedulerJobGroup结构中)	状态	enable disable	3.4.0
parameters (可选)	Map	body(包含在updateSchedulerJobGroup结构中)	定时任务组参数		3.4.0
systemTags (可选)	List	body	系统标签列表		3.4.0
userTags (可选)	List	body	用户标签列表		3.4.0

API返回

返回示例

{
  "inventory": {
    "uuid": "e344fd75079735369cbffda253cc173c",
    "name": "Test",
    "description": "create volume snapshot job",
    "createDate": "Nov 14, 2017 10:20:57 PM",
    "lastOpDate": "Nov 14, 2017 10:20:57 PM"
  }
}

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

error

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

inventory

名字	类型	描述	起始版本
uuid	String	定时任务组的UUID，唯一标示该资源	3.4.0
name	String	定时任务组名称	3.4.0
description	String	定时任务组的详细描述	3.4.0
state	String	定时任务组的状态	3.4.0
createDate	Timestamp	创建时间	3.4.0
lastOpDate	Timestamp	最后一次修改时间	3.4.0
jobData	String	任务参数	3.4.0
triggersUuid	List	触发器UUID	3.4.0

SDK示例

Java SDK

UpdateSchedulerJobGroupAction action = new UpdateSchedulerJobGroupAction();
action.uuid = "4dc1dbf847d733fc98ee2998b5e0eca2";
action.name = "Test2";
action.description = "new test";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateSchedulerJobGroupAction.Result res = action.call();

Python SDK

UpdateSchedulerJobGroupAction action = UpdateSchedulerJobGroupAction()
action.uuid = "4dc1dbf847d733fc98ee2998b5e0eca2"
action.name = "Test2"
action.description = "new test"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
UpdateSchedulerJobGroupAction.Result res = action.call()