GetCandidateIsoForAttachingVm

URLs

GET zstack/v1/vm-instances/{vmInstanceUuid}/iso-candidates

Headers

Authorization: OAuth the-session-uuid

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth fe731654cc114cc3b0cc1cb0bd437f77" \
-X GET http://localhost:8080/zstack/v1/vm-instances/1f65bf61248341708265de7d759828b2/iso-candidates

Request Parameters

Name	Type	Location	Description	Optional Value	Starting Version
vmInstanceUuid	String	url	The VM instance UUID.		0.6
systemTags	List	query	Optional. The system tags.		0.6
userTags	List	query	Optional. The user tags.		0.6

Sample Response

{
  "inventories": [
    {
      "uuid": "154c6715c5994bfd8c822fd6fc5792f8",
      "name": "TinyLinux",
      "url": "http://192.168.1.20/share/images/tinylinux.qcow2",
      "mediaType": "RootVolumeTemplate",
      "platform": "Linux",
      "format": "qcow2",
      "backupStorageRefs": [
        {
          "id": 0.0,
          "imageUuid": "154c6715c5994bfd8c822fd6fc5792f8",
          "backupStorageUuid": "e7eed90ff5fd4448b3bee5e029c96636",
          "installPath": "ceph://zs-images/f0b149e053b34c7eb7fe694b182ebffd",
          "status": "Ready"
        }
      ]
    }
  ]
}

Name	Type	Description	Starting Version
error	ErrorCode	The error code. If not null, the operation fails, or vice versa. For more information, see error.	0.6
inventories	List	See inventories.	0.6

#error

Name	Type	Description	Starting Version
code	String	The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.	0.6
description	String	The brief description of the error.	0.6
details	String	The details about the error.	0.6
elaboration	String	The reserved field. Default value: null.	0.6
opaque	LinkedHashMap	The reserved field. Default value: null.	0.6
cause	ErrorCode	The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.	0.6

#inventories

Name	Type	Description	Starting Version
uuid	String	The resource UUID.	0.6
name	String	The resource name.	0.6
description	String	The detailed description of the resource.	0.6
state	String		0.6
status	String		0.6
size	Long		0.6
actualSize	Long		0.6
md5Sum	String		0.6
url	String		0.6
mediaType	String		0.6
guestOsType	String		0.6
type	String		0.6
platform	String		0.6
format	String		0.6
system	Boolean		0.6
createDate	Timestamp	The creation date.	0.6
lastOpDate	Timestamp	The last operation date.	0.6
backupStorageRefs	List	See backupStorageRefs.	0.6

#backupStorageRefs

Name	Type	Description	Starting Version
imageUuid	String	The image UUID.	0.6
backupStorageUuid	String	The backup storage UUID.	0.6
installPath	String		0.6
exportUrl	String		0.6
exportMd5Sum	String		0.6
status	String		0.6
createDate	Timestamp	The creation date.	0.6
lastOpDate	Timestamp	The last operation date.	0.6

Java SDK

GetCandidateIsoForAttachingVmAction action = new GetCandidateIsoForAttachingVmAction();
action.vmInstanceUuid = "9602b2514d61444ebab065a9282851b1";
action.sessionId = "4d6f70aefa1141c7b54b3a1bb1c16e2b";
GetCandidateIsoForAttachingVmAction.Result res = action.call();

Python SDK

GetCandidateIsoForAttachingVmAction action = GetCandidateIsoForAttachingVmAction()
action.vmInstanceUuid = "1844fc9ceac541a7947079b6ce3bd077"
action.sessionId = "4e6c014978924a2d82177eed81bdd3d6"
GetCandidateIsoForAttachingVmAction.Result res = action.call()