Update Global Settings

PUT/zstack/v1/global-configurations/{category}/{name}/actions

Request

cURL

curl --request PUT \
  --url '/v1/global-configurations/{category}/{name}/actions' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "status": "ok",
  "method": "PUT",
  "path": "/v1/global-configurations/{category}/{name}/actions"
}

Headers

Authorization: OAuth the-session-uuid

Body

{
  "updateGlobalConfig": {
    "value": "90"
  },
  "systemTags": [],
  "userTags": []
}

In the above example, the systemTags and userTags fields are optional. They are listed to indicate that these two fields can be included in the body.

Curl Example

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"updateGlobalConfig":{"value":"90"}}' \
http://localhost:8080/zstack/v1/global-configurations/quota/scheduler.num/actions

Parameter List

Name	Type	Location	Description	Starting Version
category	String	url	Category	0.6
name	String	url	Resource name	0.6
value (Optional)	String	body (Included in the updateGlobalConfig structure)	Value	0.6
systemTags (Optional)	List	body	System tags	0.6
userTags (Optional)	List	body	User tags	0.6

API Response

Response Example

{
  "inventory": {
    "name": "scheduler.num",
    "category": "quota",
    "description": "default quota for scheduler.num",
    "defaultValue": "80",
    "value": "90"
  }
}

Name	Type	Description	Starting Version
error	ErrorCode	The error code. If not null, the operation failed. This field is null when the operation succeeds. See error for details	0.6
inventory	GlobalConfigInventory	See inventory for details	0.6

error

Name	Type	Description	Starting Version
code	String	The error code number. A globally unique identifier for the error, for example, SYS.1000, HOST.1001	0.6
description	String	A brief description of the error	0.6
details	String	The detailed error information	0.6
elaboration	String	Reserved field. Default is null	0.6
opaque	LinkedHashMap	Reserved field. Default is null	0.6
cause	ErrorCode	The root error that caused the current error. If no root error exists, this field is null	0.6

inventory

Name	Type	Description	Starting Version
name	String	Resource name	0.6
category	String		0.6
description	String	The detailed description of the resource	0.6
defaultValue	String		0.6
value	String		0.6

SDK Examples

Java SDK

UpdateGlobalConfigAction action = new UpdateGlobalConfigAction();
action.category = "quota";
action.name = "scheduler.num";
action.value = "90";
action.sessionId = "84a1a9ed2d54449db13e01f7d6face7e";
UpdateGlobalConfigAction.Result res = action.call();

Python SDK

UpdateGlobalConfigAction action = UpdateGlobalConfigAction()
action.category = "quota"
action.name = "scheduler.num"
action.value = "90"
action.sessionId = "b077cfa8599a4ff1ac4fd7ba67b20a82"
UpdateGlobalConfigAction.Result res = action.call()