Update Host Scheduling Group

PUT/zstack/v1/hostSchedulingRuleGroup/{uuid}

Request

cURL

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

{
  "status": "ok",
  "method": "PUT",
  "path": "/v1/hostSchedulingRuleGroup/{uuid}"
}

Headers

Authorization: OAuth the-session-uuid

Body

{
  "updateHostSchedulingRuleGroup": {
    "name": "test",
    "description": "desc"
  },
  "systemTags": [],
  "userTags": []
}

The systemTags and userTags fields in the above example are optional. They are listed to indicate that the body can contain these two fields.

Curl Example

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"updateHostSchedulingRuleGroup":{"name":"test","description":"desc"}}' http://localhost:8080/zstack/v1/hostSchedulingRuleGroup/7127bed5295f3a3c94d9b3dbc307450d

Parameter List

Name	Type	Location	Description	Starting Version
uuid	String	url	UUID of the resource. Uniquely identifies the resource	4.6.0
name (optional)	String	body (contained in the updateHostSchedulingRuleGroup structure)	Resource name	4.6.0
description (optional)	String	body (contained in the updateHostSchedulingRuleGroup structure)	Detailed description of the resource	4.6.0
systemTags (optional)	List	body	System tags	4.6.0
userTags (optional)	List	body	User tags	4.6.0

API Response

Response Example

{
  "inventory": {
    "uuid": "b96c8635e48435eca42d3cbfca25704f",
    "name": "test",
    "description": "desc",
    "zoneUuid": "afcd30e31ebb38a8b0a2f013fce73f7a",
    "clusterUuid": "ae9b2f516fd43913b1d458ebe5f7222d"
  }
}

Name	Type	Description	Starting Version
success	boolean		4.6.0
error	ErrorCode	Error code. If not null, the operation failed. This field is null when the operation succeeds. For details, see error	4.6.0
inventory	AffinityGroupInventory	For details, see inventory	4.6.0

error

Name	Type	Description	Starting Version
code	String	Error code number. A globally unique identifier for the error, for example, SYS.1000, HOST.1001	4.6.0
description	String	Brief description of the error	4.6.0
details	String	Detailed information about the error	4.6.0
elaboration	String	Reserved field. Default is null	4.6.0
opaque	LinkedHashMap	Reserved field. Default is null	4.6.0
cause	ErrorCode	Root error. The source error that caused the current error. This field is null if no root error exists	4.6.0

inventory

Name	Type	Description	Starting Version
uuid	String	UUID of the resource. Uniquely identifies the resource	4.6.0
name	String	Resource name	4.6.0
description	String	Detailed description of the resource	4.6.0
zoneUuid	String	Data Center UUID	4.6.0
clusterUuid	String	Cluster UUID	4.6.0
createDate	Timestamp	Creation time	4.6.0
lastOpDate	Timestamp	Last modification time	4.6.0

SDK Examples

Java SDK

UpdateHostSchedulingRuleGroupAction action = new UpdateHostSchedulingRuleGroupAction();
action.uuid = "7127bed5295f3a3c94d9b3dbc307450d";
action.name = "test";
action.description = "desc";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateHostSchedulingRuleGroupAction.Result res = action.call();

Python SDK

UpdateHostSchedulingRuleGroupAction action = UpdateHostSchedulingRuleGroupAction()
action.uuid = "7127bed5295f3a3c94d9b3dbc307450d"
action.name = "test"
action.description = "desc"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
UpdateHostSchedulingRuleGroupAction.Result res = action.call()