本文へジャンプします。

ニフティクラウド APIリファレンス

DescribeImages

処理概要

OSイメージの情報を取得します。

特定のOSイメージを指定するためには、OSイメージIDまたはOSイメージ名が必要です。OSイメージを指定しない場合は、取得可能なすべてのOSイメージ情報を取得します。無効なOSイメージを指定した場合は、エラーが返されます。

指定するパラメーター

パラメーター 説明 必須 サンプル値
ExecutableBy.n ※指定不可
Type : String
   
ImageId.n OSイメージID
Type : String
Default : 取得可能なすべてのOSイメージ
  1
ImageName.n OSイメージ名
Type : String
値 : スタンダード・カスタマイズのOSイメージ名と完全一致する文字列
Default : 取得可能なすべてのOSイメージ
   
Owner.n OSイメージの種別
Type : String
値 : niftycloud (スタンダードイメージ) | self (作成したカスタマイズイメージ) | other(ほかのユーザーが作成したカスタマイズイメージ) | 空 (すべて)
Default : 空 (すべて)
   

応答フィールド

フィールド(項目) 説明 サンプル値
DescribeImagesResponse DescribeImagesType レスポンス
Type : DescribeImagesResponseType
Ancestor : なし
Children : requestId, imagesSet
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : DescribeImagesResponse
Children : なし
f6dd8353-eb6b-6b4fd32e4f05
imagesSet 取得したOSイメージの情報セット
Type : DescribeImagesResponseInfoType
Ancestor : DescribeImagesResponse
Children : item
 
item 取得したOSイメージの情報
Type : DescribeImagesResponseItemType
Ancestor : imagesSet
Children : imageId, imageLocation, imageState, imageOwnerId, isPublic, productCodes, architecture, imageType, kernelId, ramdiskId, platform, stateReason, imageOwnerAlias, name, description, detailDescription, redistributable, placement, rootDeviceType, rootDeviceName, blockDeviceMapping
 
imageId OSイメージID
Type : xsd:string
Ancestor : item
Children : なし
1
imageLocation ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
imageState OSイメージのステータス
Type : xsd:string
値 : available (利用可能) | deregistered (利用不可)
Ancestor : item
Children : なし
available
imageOwnerId OSイメージの所有者
Type : xsd:string
値 : niftycloud (スタンダードイメージ) | self (作成したカスタマイズイメージ) | other(ほかのユーザーが作成したカスタマイズイメージ)
Ancestor : item
Children : なし
niftycloud
isPublic OSイメージの公開
Type : xsd:boolean
値 : true (スタンダードイメージまたはパブリックイメージ) | false (カスタマイズイメージ)
Ancestor : item
Children : なし
true
productCodes ※返却値なし
Type : ProductCodesSetType
Ancestor : item
Children : item
 
item ※返却値なし
Type : ProductCodesSetItemType
Ancestor : productCodes
Children : productCode
 
productCode ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
architecture OSイメージのアーキテクチャ
Type : xsd:string
値 : i386 | x86_64
Ancestor : item
Children : なし
i386
imageType OSイメージタイプ
Type : xsd:string
値 : machine
Ancestor : item
Children : なし
machine
kernelId ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
ramdiskId ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
platform OSイメージのプラットフォーム
Type : xsd:string
値 : windows | radhat | centos
Ancestor : item
Children : なし
centos
stateReason ※返却値なし
Type : StateReasonType
Ancestor : item
Children : code, message
 
code ※返却値なし
Type : xsd:string
Ancestor : stateReason
Children : なし
 
message ※返却値なし
Type : xsd:string
Ancestor : stateReason
Children : なし
 
imageOwnerAlias OSイメージを所有する企業名
Type : xsd:string
Ancestor : item
Children : なし
FUJITSU CLOUD TECHNOLOGIES LIMITED
name OSイメージ名
Type : xsd:string
Ancestor : item
Children : なし
CentOS 5.3 32bit Plain
description OSイメージのメモ情報
Type : xsd:string
Ancestor : item
Children : なし
 
detailDescription OSイメージの説明情報
Type : xsd:string
Ancestor : item
Children : なし
 
redistributable OSイメージの再配布の可否
Type : xsd:boolean
値 : true (再配布可) | false (再配布不可)
Ancestor : item
Children : なし
 
placement リージョン/ゾーン情報
Type: GlobalPlacementType
Ancestor: item
Children: regionName, availabilityZone
 
regionName リージョン情報
Type: xsd:string
Ancestor: placement
Children: なし
east-1
availabilityZone ゾーン情報
Type: xsd:string
Ancestor: placement
Children: なし
east-11
rootDeviceType OSイメージのrootデバイスタイプ
Type : xsd:string
値 : disk
Ancestor : item
Children : なし
disk
rootDeviceName ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
blockDeviceMapping 接続しているディスクの情報セット
Type : BlockDeviceMappingType
Ancestor : item
Children : item
 
item 接続しているディスクの情報
Type : BlockDeviceMappingItemType
Ancestor : blockDeviceMapping   
Children : deviceName, virtualName, ebs, noDevice
 
deviceName ディスクの接続デバイス
Type : xsd:string
値 : SCSI(xx:xx)
Ancestor : item
Children : なし
SCSI(0:1)
virtualName ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
ebs 接続しているディスクの詳細情報
Type : EbsBlockDeviceType
Ancestor : item
Children : snapshotId, volumeSize, deleteOnTermination
 
snapshotId ディスク名
Type : xsd:string
Ancestor : ebs
Children : なし
 
volumeSize ディスクサイズ
Type : xsd: integer
単位: GB
Ancestor : ebs
Children : なし
 
diskType ディスクタイプ
Type: xsd:string
値: 2 (Standard Storage) | 3 (High-Speed Storage A) | 4(High-Speed Storage B) | 5 (Flash Storage)
Ancestor: ebs
Children: なし
 
deleteOnTermination イメージ削除時のディスク消去
Type : xsd:boolean
値: true (消去) | false (消去しない)
Ancestor : ebs
Children : なし
true
noDevice ※返却値なし
Type : EmptyElementType
Ancestor : item
Children : なし
 
niftyImageSize イメージサイズ
単位 : GB
Type : xsd:int
Ancestor : item
Children : なし
 
niftyContactUrl 問い合わせ先URL
Type : xsd:string
Ancestor : item
Children : なし
 
launchTime 作成日時
形式 :yyyy-mm-ddThh:mi:ss.sssZ
Type : xsd:dateTime
Ancestor: item
Children : なし
 
niftyDistributionIds 配布先ID情報セット
Type : NiftyDistributionIdType
Ancestor : item
Children : item
 
item 配布先ID情報
Type : NiftyDistributionIdItemType
Ancestor : niftyDistributionIdType
Children : distributionId
 
distributionId 配布先@nifty法人ID
Type : xsd:string
Ancestor : NiftyDistributionIdItemType
Children : なし
 
niftyIsAllowedDistribution OSイメージの配布設定可否情報
Type : xsd:boolean
Value : true (配布設定可) | false (配布設定不可)
Ancestor : item
Children : なし
 

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=DescribeImages&ImageId.1=1&CommonParams

応答サンプル

<DescribeImagesResponse xmlns="https://cp.cloud.nifty.com/api/">
  <requestId>f6dd8353-eb6b-6b4fd32e4f05</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 />
      <detailDescription><![CDATA[...]]></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>http://cloud.nifty.com/</niftyContactUrl>
      <niftyExplanation>説明…</niftyExplanation>
      <launchTime>2014-01-01T00:00:00.000Z</launchTime>
      <niftyDistributionIds>
        <item>
          <distributionId>ZYP03286</distributionId>
        </item>
        <item>
          <distributionId>ZYP03566</distributionId>
        </item>
      </niftyDistributionIds>
      <niftyIsAllowedDistribution>false</niftyIsAllowedDistribution>
    </item>
  </imagesSet>
</DescribeImagesResponse>

ニフティクラウド サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフティクラウド公式フェイスブックページ

推奨画面サイズ 1024×768 以上