DescribeImages
処理概要
OSイメージの情報を取得します。
特定のOSイメージを指定するためには、OSイメージIDまたはOSイメージ名が必要です。OSイメージを指定しない場合は、取得可能なすべてのOSイメージ情報を取得します。
指定するパラメーター
パラメーター | 型 | 説明 | 必須 |
---|---|---|---|
ExecutableBy.n | string |
※指定不可 |
|
ImageId.n | string |
OSイメージID |
|
ImageName.n | string |
OSイメージ名 |
|
Owner.n | string |
OSイメージの種別 値:
|
応答フィールド
フィールド (項目) | 型 | 説明 |
---|---|---|
DescribeImagesResponse | - |
DescribeImages レスポンス |
␣requestId | string |
リクエスト識別子 |
␣imagesSet | - |
取得したOSイメージの情報セット |
␣␣item | - |
取得したOSイメージの情報 |
␣␣␣imageId | string |
OSイメージID |
␣␣␣imageLocation | string |
※空を返却 |
␣␣␣imageState | string |
OSイメージのステータス 値:
|
␣␣␣imageOwnerId | string |
OSイメージの所有者 値:
|
␣␣␣isPublic | boolean |
OSイメージの公開 値:
|
␣␣␣productCodes | - |
※空を返却 |
␣␣␣␣item | - |
※空を返却 |
␣␣␣␣␣productCode | string |
※空を返却 |
␣␣␣architecture | string |
OSイメージのアーキテクチャ 値:
|
␣␣␣imageType | string |
OSイメージタイプ 値:
|
␣␣␣kernelId | string |
※空を返却 |
␣␣␣ramdiskId | string |
※空を返却 |
␣␣␣platform | string |
OSイメージのプラットフォーム 値:
|
␣␣␣stateReason | - |
※空を返却 |
␣␣␣␣code | string |
※空を返却 |
␣␣␣␣message | string |
※空を返却 |
␣␣␣imageOwnerAlias | string |
OSイメージを所有する企業名 |
␣␣␣name | string |
OSイメージ名 |
␣␣␣description | string |
OSイメージのメモ情報(CDATA付き) |
␣␣␣detailDescription | string |
OSイメージの説明情報(CDATA付き) |
␣␣␣redistributable | boolean |
OSイメージの再配布の可否 値:
|
␣␣␣placement | - |
リージョン/ゾーン情報 |
␣␣␣␣regionName | string |
リージョン情報 |
␣␣␣␣availabilityZone | string |
ゾーン情報 |
␣␣␣rootDeviceType | string |
OSイメージのrootデバイスタイプ 値:
|
␣␣␣rootDeviceName | string |
※空を返却 |
␣␣␣blockDeviceMapping | - |
接続しているディスクの情報セット |
␣␣␣␣item | - |
接続しているディスクの情報 |
␣␣␣␣␣deviceName | string |
ディスクの接続デバイス 表示形式:SCSI(xx:xx) |
␣␣␣␣␣ebs | - |
接続しているディスクの詳細情報 |
␣␣␣␣␣␣snapshotId | string |
ディスク名 |
␣␣␣␣␣␣volumeSize | integer |
ディスクサイズ 単位: GB |
␣␣␣␣␣␣diskType | string |
ディスクタイプ 値:
|
␣␣␣␣␣␣deleteOnTermination | string |
イメージ削除時のディスク消去 値:
|
␣␣␣niftyImageSize | string |
イメージサイズ 単位: GB |
␣␣␣niftyContactUrl | string |
問い合わせ先URL |
␣␣␣launchTime | timestamp |
作成日時 表示形式:yyyy-mm-ddThh:mi:ss.sss+09:00 |
␣␣␣niftyDistributionIds | - |
配布先ID情報セット |
␣␣␣␣item | - |
配布先ID情報 |
␣␣␣␣␣distributionId | string |
配布先ニフクラID |
␣␣␣niftyIsAllowedDistribution | boolean |
OSイメージの配布設定可否情報 値:
|
␣␣␣isGpuConfigurable | boolean |
GPUサーバータイプの設定可否情報 値:
|
リクエストサンプル
https://jp-east-1.computing.api.nifcloud.com/api/
?Action=DescribeImages
&ImageId.1=1
&CommonParams
応答サンプル
<DescribeImagesResponse xmlns="https://computing.api.nifcloud.com/api/">
<requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
<imagesSet>
<item>
<imageId>1</imageId>
<imageLocation/>
<imageState>available</imageState>
<imageOwnerId>niftycloud</imageOwnerId>
<isPublic>true</isPublic>
<productCodes>
<item>
<productCode/>
</item>
</productCodes>
<architecture>i386</architecture>
<imageType>machine</imageType>
<kernelId/>
<ramdiskId/>
<platform>centos</platform>
<stateReason>
<code/>
<message/>
</stateReason>
<imageOwnerAlias>FUJITSU CLOUD TECHNOLOGIES LIMITED</imageOwnerAlias>
<name>CentOS 5.3 32bit Plain</name>
<description><![CDATA[memo]]></description>
<detailDescription><![CDATA[memo]]></detailDescription>
<redistributable>true</redistributable>
<placement>
<regionName>east-1</regionName>
<availabilityZone>east-11</availabilityZone>
</placement>
<rootDeviceType>disk</rootDeviceType>
<rootDeviceName/>
<blockDeviceMapping>
<item>
<deviceName>SCSI (0:1)</deviceName>
<ebs>
<snapshotId>disk0001</snapshotId>
<volumeSize>100</volumeSize>
<diskType>Standard Storage</diskType>
<deleteOnTermination>true</deleteOnTermination>
</ebs>
</item>
</blockDeviceMapping>
<niftyImageSize>30</niftyImageSize>
<niftyContactUrl>https://cloud.nifty.com/</niftyContactUrl>
<launchTime>2014-01-01T00:00:00.000+09.00</launchTime>
<niftyDistributionIds>
<item>
<distributionId>XXX012345</distributionId>
</item>
</niftyDistributionIds>
<niftyIsAllowedDistribution>false</niftyIsAllowedDistribution>
<isGpuConfigurable>false</isGpuConfigurable>
</item>
</imagesSet>
</DescribeImagesResponse>