- HOME
- 提供API一覧
- listIsos
listIsos
処理概要
ISO情報の一覧を取得
注意事項
・bootable=True以外を指定した場合(スペルミスなども含む)、Falseとして応答で返されます。(エラーにはなりません。)
・isredeyはtrueしか選択できません。(falseを選択した場合もtrueの結果が返されます。)
リクエスト
・リクエストパラメータ
| Parameter Name | Description | Required |
| bootable | true if the ISO is bootable, false otherwise | false |
| id | list ISO by id | false |
| isofilter | possible values are “featured”, “self”, “selfexecutable”,”sharedexecutable”,”executable”, and “community”. * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins). | false |
| isready | true if this ISO is ready to be deployed | false |
| keyword | List by keyword | false |
| name | list all isos by name | false |
| tags | List resources by tags (key/value pairs) | false |
| zoneid | the ID of the zone | false |
・リクエストサンプル
$ ./kick_api.sh command=listIsos isofilter=community
レスポンス
・レスポンスボディ
| Response Name | Description |
| id | the template ID |
| account | the account name to which the template belongs |
| accountid | the account id to which the template belongs |
| bootable | true if the ISO is bootable, false otherwise |
| checksum | checksum of the template |
| created | the date this template was created |
| crossZones | true if the template is managed across all Zones, false otherwise |
| details | additional key/value details tied with template |
| displaytext | the template display text |
| domain | the name of the domain to which the template belongs |
| domainid | the ID of the domain to which the template belongs |
| format | the format of the template. |
| hostid | the ID of the secondary storage host for the template |
| hostname | the name of the secondary storage host for the template |
| hypervisor | the hypervisor on which the template runs |
| isdynamicallyscalable | true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory |
| isextractable | true if the template is extractable, false otherwise |
| isfeatured | true if this template is a featured template, false otherwise |
| isready | true if the template is ready to be deployed from, false otherwise. |
| name | the template name |
| ostypeid | the ID of the OS type for this template. |
| ostypename | the name of the OS type for this template. |
| passwordenabled | true if the reset password feature is enabled, false otherwise |
| project | the project name of the template |
| projectid | the project id of the template |
| removed | the date this template was removed |
| size | the size of the template |
| sourcetemplateid | the template ID of the parent template if present |
| sshkeyenabled | true if template is sshkey enabled, false otherwise |
| status | the status of the template |
| templatetag | the tag of this template |
| templatetype | the type of the template |
| zoneid | the ID of the zone for this template |
| zonename | the name of the zone for this template |
| tags(*) | the list of resource tags associated with tempate |
| 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 |
| project | the project name where tag belongs to |
| projectid | the project id the tag belongs to |
| resourceid | id of the resource |
| resourcetype | resource type |
| value | tag value |
| jobid | the ID of the latest async job acting on this object |
| jobstatus | the current status of the latest async job acting on this object |
・レスポンスサンプル
【API実行結果】
<?xml version=”1.0″ encoding=”UTF-8″?>
<listisosresponse cloud-stack-version=”4.3.0.2″>
<count>6</count>
<iso>
<id>85b1db5b-ae66-4c39-8653-330e7fad0244</id>
<name>TEST-01.iso(Featured)</name>
<displaytext>TEST-01(Featured)</displaytext>
<created>2016-07-07T21:47:53+0900</created>
<isready>true</isready>
<bootable>false</bootable>
<isfeatured>false</isfeatured>
<crossZones>false</crossZones>
<ostypeid>9e4c3904-c234-11e4-a399-2c600c06bb24</ostypeid>
<ostypename>None</ostypename>
<account>xxxxx</account>
<zoneid>f4c460fd-06d9-44db-a54d-7a23b54d9133</zoneid>
<zonename>jp2-east01</zonename>
<status>Successfully Installed</status>
<size>62128128</size>
<domain>MXXXXXXXX</domain>
<domainid>7f470ab3-3491-4d25-b82c-39a7322b1659</domainid>
<isextractable>true</isextractable>
<checksum>0ec547893ccbd690205966d0ed17e8e0</checksum>
<tags>
<key>testkey</key>
<value>testvalue</value>
<resourcetype>ISO</resourcetype>
<resourceid>85b1db5b-ae66-4c39-8653-330e7fad0244</resourceid>
<account>xxxxx</account>
<domainid>9e3e5b0e-c234-11e4-a399-2c600c06bb24</domainid>
<domain>ROOT</domain>
</tags>
</iso>
</listisosresponse>