Top
ServerView Resource Orchestrator Cloud Edition V3.2.0 Reference Guide (API)
FUJITSU Software
Chapter 2 L-Platform API Reference > 2.1 Operations on L-Platform Templates > 2.1.5 ListDiskImage (Gets a List of Cloning Images)
PreviousNext

2.1.5 ListDiskImage (Gets a List of Cloning Images)

This API gets a list of the disk image IDs in the virtual data center. Specify the product ID corresponding to the content of the disk image when registering disk images.

Request parameters

Parameter name

Item

Item description

Version

Description

The version ID of the L-Platform API

Type

string

Value

Fixed. Specify "2.0".

Locale

Description

The language for communicating with the L-Platform API. This parameter is specified using the language codes stipulated by ISO 639.

Type

string

Value

Select one of the following:
- en: English
- zh: Chinese

Action

Description

The name of the L-Platform API to be executed

Type

string

Value

Fixed. Specify "ListDiskImage".

userId

Description

The user ID of the user that executes the L-Platform API

Type

string

Value

No more than 31 characters

orgId

Description

The tenant name of the user that executes the L-Platform API

Type

string

Value

No more than 32 characters


Response

<Status code>

The API returns "200 OK" if it terminates normally.


<XML>

<?xml version="1.0" encoding="UTF-8"?>
<ListDiskImageResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <diskimages>
    <diskimage>
      <adminUser>[Solaris 11 administrator user name]</adminUser>
      <creatorName>[Organization ID of the person who created the disk image]</creatorName>
      <diskimageId>[Disk image ID]</diskimageId>
      <diskimageName>[Disk image name]</diskimageName>
      <disks>
        <disk>
          <diskSize>[Disk size]</diskSize>
          <no>[Disk serial number]</no>
        </disk>
      </disks>
      <maxCpuPerf>[Maximum CPU performance]</maxCpuPerf>
      <maxDiskSize>[Maximum amount of disk space]</maxDiskSize>
      <maxMemorySize>[Maximum amount of memory]</maxMemorySize>
      <maxSysvolSize>[Maximum capacity of system disk]</maxSysvolSize>
      <name>[Disk image information name]</name>
      <numOfMaxCpu>[Maximum number of CPUs]</numOfMaxCpu>
      <numOfMaxDisk>[Maximum number of disks]</numOfMaxDisk>
      <numOfMaxNic>[Maximum number of NICs]</numOfMaxNic>
      <patches>
        <patch>
          <componentName>[Component name]</componentName>
          <description>[Patch description]</description>
          <patchId>[Patch ID]</patchId>
          <softwareId>[Software ID]</softwareId>
        </patch>
      </patches>
      <registrant>[ID of the person who registered the disk image]</registrant>
      <relation>[Related product name]</relation>
      <size>[Disk image size]</size>
      <softwares>
        <software>
          <category>[Software category]</category>
          <license>[License]</license>
          <name>[Software name]</name>
          <officialVersion>[Official version]</officialVersion>
          <osCategory>[Operating system category]</osCategory>
          <patch>[Patch version number]</patch>
          <softwareId>[Software ID]</softwareId>
          <support>[Support]</support>
          <version>[Version]</version>
        </software>
      </softwares>
      <storeType>[Storage location type]</storeType>
      <vdi>[Use of VDI coordination]</vdi>
      <vmType>[Virtual machine type]</vmType>
    </diskimage>
  </diskimages>
  <responseMessage>[Message]</responseMessage>
  <responseStatus>[Status]</responseStatus>
</ListDiskImageResponse>

<Elements>

Element name

Item

Item description

ListDiskImageResponse

Description

Element holding the response information

Type

None

Number of occurrences

1

diskimages

Description

Element holding the response information for the disk image information.

Type

None

Number of occurrences

0 or 1

diskimage

Description

Set of disk image information

Type

None

Number of occurrences

As many as there are diskimages elements (0 or more elements for each diskimages element).

adminUser

Description

Solaris 11 administrator user name

Type

string

Number of occurrences

As many as there are diskimage elements (0 or 1 element for each diskimage element).

creatorName

Description

The tenant name of the person who created the disk image

Type

string

Number of occurrences

As many as there are diskimage elements (0 or 1 element for each diskimage element).

diskimageId

Description

Disk image ID

Type

string

Number of occurrences

As many as there are diskimage elements (0 or 1 element for each diskimage element).

diskimageName

Description

Disk image name

Type

string

Number of occurrences

As many as there are diskimage elements (0 or 1 element for each diskimage element).

disks

Description

Element holding the response information for the disk information

Type

None

Number of occurrences

As many as there are diskimage elements (0 or 1 element for each diskimage element).

disk

Description

Set of disk information

Type

None

Number of occurrences

As many as there are disks elements (0 or more elements for each disks element).

diskSize

Description

Disk size. The units are "GB".

Type

string

Number of occurrences

As many as there are disk elements (0 or 1 element for each disk element).

no

Description

Disk serial number

Type

string

Number of occurrences

As many as there are disk elements (0 or 1 element for each disk element).

maxCpuPerf

Description

Maximum CPU performance

Type

decimal

Number of occurrences

As many as there are diskimage elements (0 or 1 element for each diskimage element).

maxDiskSize

Description

Maximum amount of disk space

Type

decimal

Number of occurrences

As many as there are diskimage elements (0 or 1 element for each diskimage element).

maxMemorySize

Description

Maximum amount of memory

Type

decimal

Number of occurrences

As many as there are diskimage elements (0 or 1 element for each diskimage element).

maxSysvolSize

Description

Maximum capacity of system disk

Type

decimal

Number of occurrences

As many as there are diskimage elements (0 or 1 element for each diskimage element).

name

Description

Disk image information name

Type

string

Number of occurrences

As many as there are diskimage elements (0 or 1 element for each diskimage element).

numOfMaxCpu

Description

Maximum number of CPUs

Type

int

Number of occurrences

As many as there are diskimage elements (0 or 1 element for each diskimage element).

numOfMaxDisk

Description

Maximum number of disks

Type

int

Number of occurrences

As many as there are diskimage elements (0 or 1 element for each diskimage element).

numOfMaxNic

Description

Maximum number of NICs

Type

int

Number of occurrences

As many as there are diskimage elements (0 or 1 element for each diskimage element).

patches

Description

Element holding the response information for the patch information.

Type

None

Number of occurrences

As many as there are diskimage elements (0 or 1 element for each diskimage element).

patch

Description

Set of patch information

Type

None

Number of occurrences

As many as there are patches elements (0 or more elements for each patches element).

componentName

Description

Component name

Type

string

Number of occurrences

As many as there are patch elements (0 or 1 element for each patch element).

description

Description

Patch description

Type

string

Number of occurrences

As many as there are patch elements (0 or 1 element for each patch element).

patchId

Description

Patch ID

Type

string

Number of occurrences

As many as there are patch elements (0 or 1 element for each patch element).

softwareId

Description

Software ID

Type

string

Number of occurrences

As many as there are patch elements (0 or 1 element for each software element).

registrant

Description

The ID of the person who registered the disk image

Type

string

Number of occurrences

As many as there are diskimage elements (0 or 1 element for each diskimage element).

relation

Description

Related product name

Type

string

Number of occurrences

As many as there are diskimage elements (0 or 1 element for each diskimage element).

size

Description

Disk image size. The units are "GB".

Type

decimal

Number of occurrences

As many as there are diskimage elements (0 or 1 element for each diskimage element).

softwares

Description

Element holding the response information for the software information.

Type

None

Number of occurrences

As many as there are diskimage elements (0 or 1 element for each diskimage element).

software

Description

Set of software information

Type

None

Number of occurrences

As many as there are softwares elements (0 or more elements for each softwares element).

category

Description

Software category

Type

string

Number of occurrences

As many as there are software elements (0 or 1 element for each software element).

license

Description

License

Type

string

Number of occurrences

As many as there are software elements (0 or 1 element for each software element).

name

Description

Software name

Type

string

Number of occurrences

As many as there are software elements (0 or 1 element for each software element).

officialVersion

Description

Official version

Type

string

Number of occurrences

As many as there are software elements (0 or 1 element for each software element).

osCategory

Description

Operating system category

Type

string

Number of occurrences

As many as there are software elements (0 or 1 element for each software element).

patch

Description

Patch version

Type

string

Number of occurrences

As many as there are software elements (0 or 1 element for each software element).

softwareId

Description

Software ID

Type

string

Number of occurrences

As many as there are software elements (0 or 1 element for each patch element).

support

Description

Support

Type

string

Number of occurrences

As many as there are software elements (0 or 1 element for each software element).

version

Description

Version number

Type

string

Number of occurrences

As many as there are software elements (0 or 1 element for each software element).

storeType

Description

Storage location type. This is one of the following:

- Virtual Disk: Virtual storage
- Raw Disk: Existing disk

Type

string

Number of occurrences

As many as there are diskimage elements (0 or 1 element for each diskimage element).

vdi

Description

Specifies whether to use VDI coordination.
- true: Use VDI coordination
When the VDI coordination is not used, this tag is not displayed.

Type

string

Number of occurrences

As many as there are diskimage elements (0 or 1 element for each diskimage element).

vmType

Description

Virtual machine type.
Refer to "15.2.2 Virtual L-Server Templates" in the "Reference Guide (Command/XML) CE" for details.

Type

string

Number of occurrences

As many as there are diskimage elements (0 or 1 element for each diskimage element).

responseMessage

Description

Message. This element indicates whether the request has been processed correctly.
Refer to "Chapter 15 Messages Starting with PAPI" in the "Messages" for message details.

Type

string

Number of occurrences

1

responseStatus

Description

Status. This element indicates whether the request has been processed normally. "SUCCESS" is returned if the request is processed normally. Otherwise, an error code is returned.
Refer to "Appendix A List of Response Status Error Codes(L-Platform APIs)" for information on error codes.

Type

string

Number of occurrences

1


Sample response

<?xml version="1.0" encoding="UTF-8"?>
<ListDiskImageResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <diskimages>
    <diskimage>
      <creatorName>cfmgadm</creatorName>
      <diskimageId>image-13f2b6162a3</diskimageId>
      <diskimageName>g-vm-0002</diskimageName>
      <disks>
        <disk>
          <diskSize>400.0</diskSize>
          <no>3</no>
        </disk>
        <disk>
          <diskSize>500.0</diskSize>
          <no>5</no>
        </disk>
      </disks>
      <maxCpuPerf>1.4</maxCpuPerf>
      <maxDiskSize>500.0</maxDiskSize>
      <maxMemorySize>2.0</maxMemorySize>
      <maxSysvolSize>70.0</maxSysvolSize>
      <name>data_disks</name>
      <numOfMaxCpu>1</numOfMaxCpu>
      <numOfMaxDisk>5</numOfMaxDisk>
      <numOfMaxNic>1</numOfMaxNic>
      <registrant>manage1</registrant>
      <size>70.0</size>
      <softwares>
        <software>
          <category>OS</category>
          <license/>
          <name>Windows Server 2008 R2 Enterprise</name>
          <officialVersion/>
          <osCategory>windows64</osCategory>
          <patch/>
          <softwareId>SW00000007</softwareId>
          <support/>
          <version>6.1</version>
        </software>
      </softwares>
      <vmType>VMware</vmType>
    </diskimage>
    <diskimage>
      <creatorName>cfmgadm</creatorName>
      <diskimageId>image-13d23c1c832</diskimageId>
      <diskimageName>g-vm-0001</diskimageName>
      <maxCpuPerf>3.2</maxCpuPerf>
      <maxDiskSize>30.0</maxDiskSize>
      <maxMemorySize>8.0</maxMemorySize>
      <maxSysvolSize>50.0</maxSysvolSize>
      <name>solaristest</name>
      <numOfMaxCpu>4</numOfMaxCpu>
      <numOfMaxDisk>1</numOfMaxDisk>
      <numOfMaxNic>1</numOfMaxNic>
      <patches>
        <patch>
          <componentName/>
          <description/>
          <patchId>PATCH1</patchId>
          <softwareId>SW00000016</softwareId>
        </patch>
        <patch>
          <componentName/>
          <description/>
          <patchId>PATCH2</patchId>
          <softwareId>SW00000016</softwareId>
        </patch>
      </patches>
      <registrant>manage1</registrant>
      <size>50.0</size>
      <softwares>
        <software>
          <category>OS</category>
          <license/>
          <name>FreeOS</name>
          <officialVersion/>
          <osCategory>other</osCategory>
          <patch/>
          <softwareId>SW00000016</softwareId>
          <support/>
          <version>1.0</version>
        </software>
      </softwares>
      <vmType>VMware</vmType>
    </diskimage>
  </diskimages>
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
</ListDiskImageResponse>

PreviousNext
Copyright 2011-2016 FUJITSU LIMITED