本文へジャンプします。

ニフクラ ユーザーガイド

DescribeImages

処理概要

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

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

指定するパラメーター

パラメーター 説明 必須
ExecutableBy.n string ※指定不可
ImageId.n string OSイメージID
ImageName.n string OSイメージ名
Owner.n string OSイメージの種別
値: niftycloud (スタンダードイメージ) | self (作成したカスタマイズイメージ) | other (ほかのユーザーが作成したカスタマイズイメージ)
Default: 空 (すべて)

応答フィールド

フィールド (項目) 説明
DescribeImagesResponse - DescribeImages レスポンス
Ancestor: なし
Children: requestId | imagesSet
requestId string リクエスト識別子
Ancestor: DescribeImagesResponse
Children: なし
imagesSet - 取得したOSイメージの情報セット
Ancestor: DescribeImagesResponse
Children: item
item - 取得したOSイメージの情報
Ancestor: imagesSet
Children: imageId | imageLocation | imageState | imageOwnerId | isPublic | productCodes | architecture | imageType | kernelId | ramdiskId | platform | stateReason | imageOwnerAlias | name | description | detailDescription | redistributable | placement | rootDeviceType | rootDeviceName | blockDeviceMapping | niftyImageSize | niftyContactUrl | launchTime | niftyDistributionIds | niftyIsAllowedDistribution
imageId string OSイメージID
Ancestor: item
Children: なし
imageLocation string ※空を返却
Ancestor: item
Children: なし
imageState string OSイメージのステータス
値: available (利用可能) | deregistered (利用不可)
Ancestor: item
Children: なし
imageOwnerId string OSイメージの所有者
値: niftycloud (スタンダードイメージ) | self (作成したカスタマイズイメージ) | other(ほかのユーザーが作成したカスタマイズイメージ)
Ancestor: item
Children: なし
isPublic boolean OSイメージの公開
値: true (スタンダードイメージまたはパブリックイメージ) | false (カスタマイズイメージ)
Ancestor: item
Children: なし
productCodes - ※空を返却
Ancestor: item
Children: item
item - ※空を返却
Ancestor: productCodes
Children: productCode
productCode string ※空を返却
Ancestor: item
Children: なし
architecture string OSイメージのアーキテクチャ
値: i386 | x86_64
Ancestor: item
Children: なし
imageType string OSイメージタイプ
値: machine
Ancestor: item
Children: なし
kernelId string ※空を返却
Ancestor: item
Children: なし
ramdiskId string ※空を返却
Ancestor: item
Children: なし
platform string OSイメージのプラットフォーム
値: windows | radhat | centos
Ancestor: item
Children: なし
stateReason - ※空を返却
Ancestor: item
Children: code | message
code integer ※空を返却
Ancestor: stateReason
Children: なし
message string ※空を返却
Ancestor: stateReason
Children: なし
imageOwnerAlias string OSイメージを所有する企業名
Ancestor: item
Children: なし
name string OSイメージ名
Ancestor: item
Children: なし
description string OSイメージのメモ情報(CDATA付き)
Ancestor: item
Children: なし
detailDescription string OSイメージの説明情報(CDATA付き)
Ancestor: item
Children: なし
redistributable boolean OSイメージの再配布の可否
値: true (再配布可) | false (再配布不可)
Ancestor: item
Children: なし
placement - リージョン/ゾーン情報
Ancestor: item
Children: regionName | availabilityZone
regionName string リージョン情報
Ancestor: placement
Children: なし
availabilityZone string ゾーン情報
Ancestor: placement
Children: なし
rootDeviceType string OSイメージのrootデバイスタイプ
値: disk
Ancestor: item
Children: なし
rootDeviceName string ※空を返却
Ancestor: item
Children: なし
blockDeviceMapping - 接続しているディスクの情報セット
Ancestor: item
Children: item
item - 接続しているディスクの情報
Ancestor: blockDeviceMapping
Children: deviceName | ebs
deviceName string ディスクの接続デバイス
表示形式:SCSI(xx:xx)
Ancestor: item
Children: なし
ebs - 接続しているディスクの詳細情報
Ancestor: item
Children: snapshotId | volumeSize | diskType | deleteOnTermination
snapshotId string ディスク名
Ancestor: ebs
Children: なし
volumeSize integer ディスクサイズ
単位: GB
Ancestor: ebs
Children: なし
diskType string ディスクタイプ
値: Standard Storage(標準ディスク) | High-Speed Storage A(高速ディスクA) | High-Speed Storage B(高速ディスクB) | Flash Storage(フラッシュドライブ) | Standard Flash Storage A(標準フラッシュドライブA) | Standard Flash Storage B(標準フラッシュドライブB) | High-Speed Flash Storage A(高速フラッシュドライブA) | High-Speed Flash Storage B(高速フラッシュドライブB)
Ancestor: ebs
Children: なし
deleteOnTermination boolean イメージ削除時のディスク消去
値: true (消去) | false (消去しない)
Ancestor: ebs
Children: なし
niftyImageSize integer イメージサイズ
単位: GB
Ancestor: item
Children: なし
niftyContactUrl string 問い合わせ先URL
Ancestor: item
Children: なし
launchTime timestamp 作成日時
表示形式:yyyy-mm-ddThh:mi:ss.sss+09:00
Ancestor: item
Children: なし
niftyDistributionIds - 配布先ID情報セット
Ancestor: item
Children: item
item - 配布先ID情報
Ancestor: niftyDistributionIds
Children: distributionId
distributionId string 配布先ニフクラID
Ancestor: item
Children: なし
niftyIsAllowedDistribution boolean OSイメージの配布設定可否情報
値: true (配布設定可) | false (配布設定不可)
Ancestor: item
Children: なし

リクエストサンプル

    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>
    </item>
  </imagesSet>
</DescribeImagesResponse>

  

ニフクラ サイト内検索

APIメニュー

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

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