システム内にある仮想マシンIDの一覧を取得します。
リクエストパラメーター
パラメーター名 | 項目 | 項目説明 |
|---|---|---|
Version | 説明 | CFMG APIのバージョンID |
型 | string ASCII | |
設定内容 | 固定。「1.0」を指定してください。 | |
Locale | 説明 | CFMG APIと通信するための言語。ISO 639で規定されている言語コードを指定します。 |
型 | string ASCII | |
設定内容 | 以下から選択します。 | |
Action | 説明 | 実行するCFMG APIの名称 |
型 | string ASCII | |
設定内容 | 固定。「ListVServer」を指定してください。 | |
userId | 説明 | CFMG APIを実行するユーザーID |
型 | string ASCII | |
設定内容 | 31文字以内 | |
orgId | 説明 | CFMG APIを実行するユーザーの組織ID |
型 | string ASCII | |
設定内容 | 8文字以内 | |
vsysId | 説明 | システムID |
型 | string ASCII | |
設定内容 | 32文字以内 |
レスポンス
《ステータスコード》
正常に終了した場合に「200 OK」を返します。
《XML》
<?xml version="1.0" encoding="UTF-8"?>
<ListVServerResponse xmlns=~»~http~://cfmg.systemwalker.jp.fujitsu.com~»>
<responseMessage>[メッセージ]</responseMessage>
<responseStatus>[ステータス]</responseStatus>
<vservers>
<vserver>
<creator>[仮想マシン作成者の組織ID]</creator>
<diskimageId>[ディスクイメージID]</diskimageId>
<vdisks>
<vdisk>
<attachedTo>[増設ディスクが取り付けられている仮想マシンID]</attachedTo>
<creator>[増設ディスク作成者の組織ID]</creator>
<size>[増設ディスクサイズ]</size>
<vdiskId>[増設ディスクID]</vdiskId>
<vdiskName>[増設ディスク名]</vdiskName>
</vdisk>
</vdisks>
<vserverId>[仮想マシンID]</vserverId>
<vserverName>[仮想マシン名]</vserverName>
<vserverType>[仮想マシンタイプ]</vserverType>
</vserver>
</vservers>
</ListVServerResponse>《要素》
要素名 | 項目 | 項目説明 |
|---|---|---|
ListVServerResponse | 説明 | レスポンスの情報を持つ要素 |
型 | なし | |
出現回数 | 1 | |
responseMessage | 説明 | メッセージ。リクエストが正しく処理されたかどうかを表します。メッセージの詳細については、「付録A メッセージ」を参照してください。 |
型 | string UTF-8 | |
出現回数 | 1 | |
responseStatus | 説明 | ステータス。リクエストが正常に処理されたかどうかを表します。正常に処理された場合は "SUCCESS" が返却されます。それ以外の場合はエラーコードが返却されます。 |
型 | string ASCII | |
出現回数 | 1 | |
vservers | 説明 | 仮想マシン情報のレスポンス情報を持つ要素 |
型 | なし | |
出現回数 | 0または1 | |
vserver | 説明 | 仮想マシン情報の一式 |
型 | なし | |
出現回数 | 0以上 | |
creator | 説明 | 仮想マシン作成者の組織ID |
型 | string ASCII | |
出現回数 | vserverの数分(それぞれに対して0または1) | |
diskimageId | 説明 | ディスクイメージID |
型 | string ASCII | |
出現回数 | vserverの数分(それぞれに対して0または1) | |
vdisks | 説明 | 増設ディスク情報のレスポンス情報を持つ要素 |
型 | なし | |
出現回数 | vserverの数分(それぞれに対して0または1) | |
vdisk | 説明 | 増設ディスク情報の一式 |
型 | なし | |
出現回数 | 0以上 | |
attachedTo | 説明 | 増設ディスクが取り付けられている仮想マシンID |
型 | string ASCII | |
出現回数 | vdiskの数分(それぞれに対して0または1) | |
creator | 説明 | 増設ディスク作成者の組織ID |
型 | string ASCII | |
出現回数 | vdiskの数分(それぞれに対して0または1) | |
size | 説明 | 増設ディスクサイズ。「GB」単位で指定します。 |
型 | decimal | |
出現回数 | vdiskの数分(それぞれに対して0または1) | |
vdiskId | 説明 | 増設ディスクID |
型 | string ASCII | |
出現回数 | vdiskの数分(それぞれに対して0または1) | |
vdiskName | 説明 | 増設ディスク名 |
型 | string UTF-8 | |
出現回数 | vdiskの数分(それぞれに対して0または1) | |
vserverId | 説明 | 仮想マシンID |
型 | string ASCII | |
出現回数 | vserverの数分(それぞれに対して0または1) | |
vserverName | 説明 | 仮想マシン名 |
型 | string UTF-8 | |
出現回数 | vserverの数分(それぞれに対して0または1) | |
vserverType | 説明 | 仮想マシンタイプ |
型 | string ASCII | |
出現回数 | vserverの数分(それぞれに対して0または1) |
サンプルレスポンス
<?xml version="1.0" encoding="UTF-8"?>
<ListVServerResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
<responseMessage>PAPI00000 Processing was completed.</responseMessage>
<responseStatus>SUCCESS</responseStatus>
<vservers>
<vserver>
<creator>testorg</creator>
<diskimageId>image_id_1</diskimageId>
<vdisks>
<vdisk>
<attachedTo>testorg-vsys-3-S-0001</attachedTo>
<creator>testorg</creator>
<size>12.2</size>
<vdiskId>testorg-vsys-3-D-0001</vdiskId>
<vdiskName>DISK1</vdiskName>
</vdisk>
<vdisk>
<attachedTo>testorg-vsys-3-S-0001</attachedTo>
<creator>testorg</creator>
<size>15.5</size>
<vdiskId>testorg-vsys-3-D-0002</vdiskId>
<vdiskName>DISK2</vdiskName>
</vdisk>
</vdisks>
<vserverId>testorg-vsys-3-S-0001</vserverId>
<vserverName>ap2</vserverName>
<vserverType>island12_100</vserverType>
</vserver>
<vserver>
<creator>testorg</creator>
<diskimageId>ROR-manager_382</diskimageId>
<vdisks>
<vdisk>
<attachedTo>testorg-vsys-3-S-0002</attachedTo>
<creator>testorg</creator>
<size>16.6</size>
<vdiskId>testorg-vsys-3-D-0003</vdiskId>
<vdiskName>DISK3</vdiskName>
</vdisk>
</vdisks>
<vserverId>testorg-vsys-3-S-0002</vserverId>
<vserverName>ap1</vserverName>
<vserverType>island12_100</vserverType>
</vserver>
</vservers>
</ListVServerResponse>