UploadFileToVm

API Request

URLs

POST zstack/v1/upload-file

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "vmInstanceUuids": [
      "358310f6b6b23b9f9bdcf8d34b03719f"
    ],
    "fileContent": "ZWNobyBoZWxsb3dvcmxkCg\u003d\u003d",
    "remotePath": "/var/lib/zstack/uploadfile"
  },
  "systemTags": [],
  "userTags": []
}

Note: 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 POST -d '{"params":{"vmInstanceUuids":["358310f6b6b23b9f9bdcf8d34b03719f"],"fileContent":"ZWNobyBoZWxsb3dvcmxkCg==","remotePath":"/var/lib/zstack/uploadfile"}}' http://localhost:8080/zstack/v1/upload-file

Request Parameters

Name	Type	Location	Description	Starting Version
vmInstanceUuids	List	body (contained in the params structure)	The VM instances that the files are uploaded to.	5.2.0
fileContent	String	body (contained in the params structure)	The file content which is encoded using Base64.	5.2.0
remotePath	String	body (contained in the params structure)	The absolute path that the files are uploaded to. The path contains the file name.	5.2.0
systemTags	List	body	Optional. The system tags.	5.2.0
userTags	List	body	Optional. The user tags.	5.2.0

API Response

When the API succeeded, an empty JSON structure {} is returned. When the API failed, the returned JSON structure includes 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 Sample

Java SDK

UploadFileToVmAction action = new UploadFileToVmAction();
action.vmInstanceUuids = asList("358310f6b6b23b9f9bdcf8d34b03719f");
action.fileContent = "ZWNobyBoZWxsb3dvcmxkCg==";
action.remotePath = "/var/lib/zstack/uploadfile";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UploadFileToVmAction.Result res = action.call();

Python SDK

UploadFileToVmAction action = UploadFileToVmAction()
action.vmInstanceUuids = [358310f6b6b23b9f9bdcf8d34b03719f]
action.fileContent = "ZWNobyBoZWxsb3dvcmxkCg=="
action.remotePath = "/var/lib/zstack/uploadfile"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
UploadFileToVmAction.Result res = action.call()

PreviousExecuteGuestVmCommand NextVolume Operations