VM Related Interfaces

Add Resources to Group Directory

POST/zstack/v1/add/resources/directory

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "resourceUuids": [
      "ac852a8d7c8f3e15811e8f647f24d0f7",
      "5bde5466936638648574ac73fa0abeb0"
    ],
    "directoryUuid": "1eb4cb0f7ed33305aba79b4af9ac4594"
  },
  "systemTags": [],
  "userTags": []
}

In the example above, systemTags and userTags fields can be omitted. 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 POST -d '{"params":{"resourceUuids":["ac852a8d7c8f3e15811e8f647f24d0f7","5bde5466936638648574ac73fa0abeb0"],"directoryUuid":"1eb4cb0f7ed33305aba79b4af9ac4594"}}' http://localhost:8080/zstack/v1/add/resources/directory

Parameter List

NameTypeLocationDescriptionAllowed ValuesStarting Version
resourceUuidsListbody(contained in params structure)Batch Resource UUID 4.6.0
directoryUuidStringbody(contained in params structure)Directory UUID 4.6.0
systemTags (optional)ListbodySystem Tags 4.6.0
userTags (optional)ListbodyUser Tags 4.6.0

API Response

This API returns an empty JSON structure {} on success. On error, the returned JSON structure contains an error field, for example:

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

SDK Examples

Java SDK

AddResourcesToDirectoryAction action = new AddResourcesToDirectoryAction();
action.resourceUuids = asList("ac852a8d7c8f3e15811e8f647f24d0f7","5bde5466936638648574ac73fa0abeb0");
action.directoryUuid = "1eb4cb0f7ed33305aba79b4af9ac4594";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
AddResourcesToDirectoryAction.Result res = action.call();

Python SDK

AddResourcesToDirectoryAction action = AddResourcesToDirectoryAction()
action.resourceUuids = [ac852a8d7c8f3e15811e8f647f24d0f7, 5bde5466936638648574ac73fa0abeb0]
action.directoryUuid = "1eb4cb0f7ed33305aba79b4af9ac4594"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
AddResourcesToDirectoryAction.Result res = action.call()