- HOME
- 提供API一覧
- listPremiumVirtualMachines
listPremiumVirtualMachines
処理概要
Premiumホスト上の仮想サーバの一覧を取得
注意事項
・なし
リクエスト
・リクエストパラメータ
| Parameter Name | Description | Required |
| id | the ID of the virtual machine | false |
| keyword | List by keyword | false |
| name | name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned) | false |
| state | state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed. | false |
| templateid | list vms by template | false |
| zoneid | the availability zone ID | false |
・リクエストサンプル
$ ./kick_api.sh command=listPremiumVirtualMachines
レスポンス
・レスポンスボディ
| Response Name | Description |
| id | the ID of the virtual machine |
| cpunumber | the number of cpu this virtual machine is running with |
| cpuspeed | the speed of each cpu |
| cpuused | the amount of the vm’s CPU currently used |
| created | the date when this virtual machine was created |
| displayname | user generated name. The name of the virtual machine is returned if no displayname exists. |
| displayvm | an optional field whether to the display the vm to the end user or not. |
| domain | the name of the domain in which the virtual machine exists |
| domainid | the ID of the domain in which the virtual machine exists |
| guestosid | Os type ID of the virtual machine |
| haenable | true if high-availability is enabled, false otherwise |
| hostname | the name of the host for the virtual machine |
| hypervisor | the hypervisor on which the template runs |
| instancename | instance name of the user vm; this parameter is returned to the ROOT admin only |
| isdynamicallyscalable | true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. |
| isodisplaytext | an alternate display text of the ISO attached to the virtual machine |
| isoid | the ID of the ISO attached to the virtual machine |
| isoname | the name of the ISO attached to the virtual machine |
| keypair | ssh key-pair |
| memory | the memory allocated for the virtual machine |
| name | the name of the virtual machine |
| networkkbsread | the incoming network traffic on the vm |
| networkkbswrite | the outgoing network traffic on the host |
| ostypeid | OS type id of the vm |
| passwordenabled | true if the password rest feature is enabled, false otherwise |
| rootdeviceid | device ID of the root volume |
| rootdevicetype | device type of the root volume |
| serviceofferingid | the ID of the service offering of the virtual machine |
| serviceofferingname | the name of the service offering of the virtual machine |
| servicestate | State of the Service from LB rule |
| state | the state of the virtual machine |
| templatedisplaytext | an alternate display text of the template for the virtual machine |
| templateid | the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file. |
| templatename | the name of the template for the virtual machine |
| zoneid | the ID of the availablility zone for the virtual machine |
| zonename | the name of the availability zone for the virtual machine |
| nic(*) | the list of nics associated with vm |
| id | the ID of the nic |
| broadcasturi | the broadcast uri of the nic |
| deviceid | device id for the network when plugged into the virtual machine |
| gateway | the gateway of the nic |
| ipaddress | the ip address of the nic |
| isdefault | true if nic is default, false otherwise |
| isolationuri | the isolation uri of the nic |
| macaddress | true if nic is default, false otherwise |
| netmask | the netmask of the nic |
| networkid | the ID of the corresponding network |
| networkname | the name of the corresponding network |
| nsxlogicalswitch | Id of the NSX Logical Switch (if NSX based), null otherwise |
| nsxlogicalswitchport | Id of the NSX Logical Switch Port (if NSX based), null otherwise |
| traffictype | the traffic type of the nic |
| type | the type of the nic |
| virtualmachineid | Id of the vm to which the nic belongs |
| tags(*) | the list of resource tags associated with vm |
| account | the account associated with the tag |
| customer | customer associated with the tag |
| domain | the domain associated with the tag |
| domainid | the ID of the domain associated with the tag |
| key | tag key name |
| resourceid | id of the resource |
| resourcetype | resource type |
| value | tag value |
・レスポンスサンプル
【API実行結果】
<?xml version=”1.0″ encoding=”UTF-8″ standalone=”yes”?>
<listpremiumvirtualmachinesresponse cloud-stack-version=”4.3.0.2″>
<count>1</count>
<virtualmachine>
<account>xxxxx</account>
<cpunumber>6</cpunumber>
<cpuspeed>2590</cpuspeed>
<created>2016-06-20T20:37:23+09:00</created>
<displayname>p-test01-MXXXXXXXX</displayname>
<domain>MXXXXXXXX</domain>
<domainid>5d6c8a68-59e1-4f92-b5c2-b7bf4090ea17</domainid>
<guestosid>d4ed8d1e-c234-11e4-a399-2c600c06bb24</guestosid>
<haenable>true</haenable>
<hostname>jp2-east01-Losv-003261</hostname>
<hypervisor>VMware</hypervisor>
<id>f16e5080-e61a-49d4-a760-542c8f02704c</id>
<isdynamicallyscalable>true</isdynamicallyscalable>
<jobid>393ea120-d334-4cde-a623-f5fd1b91fcad</jobid>
<jobstatus>0</jobstatus>
<memory>2048</memory>
<name>p-test01-MXXXXXXXX</name>
<networkkbsread>0</networkkbsread>
<networkkbswrite>0</networkkbswrite>
<nic>
<broadcasturi>vlan://2720</broadcasturi>
<gateway>10.1.1.1</gateway>
<id>dc4fa009-7d76-480e-a045-3757baa2f9e3</id>
<ipaddress>10.1.1.113</ipaddress>
<isdefault>true</isdefault>
<isolationuri>vlan://2720</isolationuri>
<macaddress>02:00:4b:c2:00:0d</macaddress>
<netmask>255.255.255.0</netmask>
<networkid>4f73b612-af99-4a78-8c8c-3801bbe88e2f</networkid>
<networkname>PublicFrontSegmet</networkname>
<traffictype>Guest</traffictype>
<type>Isolated</type>
</nic>
<nic>
<broadcasturi>vlan://3001</broadcasturi>
<gateway>198.18.14.129</gateway>
<id>cf020a83-6f03-4e00-afa6-d76e076a0e63</id>
<ipaddress>198.18.14.132</ipaddress>
<isdefault>false</isdefault>
<isolationuri>vlan://3001</isolationuri>
<macaddress>06:4e:10:09:9c:bd</macaddress>
<netmask>255.255.255.224</netmask>
<networkid>ec3373fe-b308-4900-a283-2f028a249137</networkid>
<networkname>MonitoringNetwork</networkname>
<traffictype>Guest</traffictype>
<type>Shared</type>
</nic>
<passwordenabled>true</passwordenabled>
<rootdeviceid>0</rootdeviceid>
<rootdevicetype>ROOT</rootdevicetype>
<serviceofferingid>5f282fad-5c90-4375-95e2-2e2ba9487c07</serviceofferingid>
<serviceofferingname>Premium_6vCPU_Mem2GB</serviceofferingname>
<state>Starting</state>
<templatedisplaytext>test01-template</templatedisplaytext>
<templateid>887d7f4b-4398-4612-86ff-50966423f7d4</templateid>
<templatename>test01-template</templatename>
<zoneid>f4c460fd-06d9-44db-a54d-7a23b54d9133</zoneid>
<zonename>jp2-east01</zonename>
</virtualmachine>
</listpremiumvirtualmachinesresponse>