InstallSoftwarePackage

PUT/zstack/v1/software-package/install/{uuid}/actions

Headers

Authorization: OAuth the-session-uuid

Body

{
  "installSoftwarePackage": {
    "config": "{}"
  },
  "systemTags": [],
  "userTags": []
}

In the preceding sample, both systemTags and userTags are optional. These two fields can be included in the body structure.

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"installSoftwarePackage":{"config":"{}"}}' \
http://localhost:8080/zstack/v1/software-package/install/ff04e1736ec6391f9a1f023b524d0a00/actions

Parameter List

NameTypeLocationDescriptionAllowed ValuesStarting Version
uuidStringurlThe software package UUID. 4.10.20
config (Optional)Stringbody (contained in the installSoftwarePackage structure)The software package installation configuration. 4.10.20
systemTags (Optional)ListbodyThe system tags. 4.10.20
userTags (Optional)ListbodyThe user tags. 4.10.20
  • The parameters for installing the software package.
  • SystemTag format: installConfig::{%s}
  • SystemTag example: APIInstallSoftwarePackageMsg converted to json string

API Response

This API returns an empty JSON structure {} on success, and returns a JSON structure containing an error field on failure. For example:

{
  "error": {
    "code": "SYS.1001",
    "description": "A message or a operation timeout",
    "details": "Create VM on KVM timeout after 300s"
  }
}

SDK Sample

Java SDK

InstallSoftwarePackageAction action = new InstallSoftwarePackageAction();
action.uuid = "ff04e1736ec6391f9a1f023b524d0a00";
action.config = "{}";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
InstallSoftwarePackageAction.Result res = action.call();

Python SDK

action = InstallSoftwarePackageAction()
action.uuid = "ff04e1736ec6391f9a1f023b524d0a00"
action.config = "{}"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()