本文へジャンプします。

ニフクラ ユーザーガイド

ImportInstance

処理概要

指定したOVFファイルの情報に基づいて、サーバーインポートを予約します。
1回のリクエストで1台のサーバーが予約可能です。

イメージ(VMDKファイル)は、別途アップロード領域へアップロードしてください(このAPIのレスポンスに含まれるタスクIDを指定します)。

サーバーの作成には、時間がかかることがあります。
API「DescribeInstances」のレスポンス値「instanceState」でサーバーのステータスを確認できます。

インポートしたサーバーは通常ほかのサーバー作成と同様に課金されますが、ニフクラの基本ディスク容量(Linux:30GB、Windows:80GB)を超えるディスクを持つ場合は100GB単位で追加料金が発生します。

インポートしたサーバーは、APIからの削除が可能です。
APIからの削除を禁止したい場合は、インポート完了後にAPI「ModifyInstanceAttribute」を実行してください。

本機能については、POSTのみの対応となりますので、ご注意ください。

指定するパラメーター

パラメーター 説明 必須
Description string メモ
Architecture string ※指定不可
SecurityGroup.n string 適用するファイアウォールグループ名
UserData string ※指定不可
InstanceType string サーバータイプ
値:
  • e-mini
  • mini
  • c-small
  • e-small
  • small
  • c-small2
  • e-small2
  • small2
  • c-small4
  • e-small4
  • small4
  • e-small8
  • small8
  • e-small16
  • small16
  • c-medium
  • e-medium
  • medium
  • c-medium4
  • e-medium4
  • medium4
  • c-medium8
  • e-medium8
  • medium8
  • e-medium16
  • medium16
  • e-medium24
  • medium24
  • c-large
  • e-large
  • large
  • c-large8
  • e-large8
  • large8
  • e-large16
  • large16
  • e-large24
  • large24
  • e-large32
  • large32
  • e-extra-large8
  • extra-large8
  • e-extra-large16
  • extra-large16
  • e-extra-large24
  • extra-large24
  • e-extra-large32
  • extra-large32
  • e-extra-large48
  • extra-large48
  • e-double-large16
  • double-large16
  • e-double-large24
  • double-large24
  • e-double-large32
  • double-large32
  • e-double-large48
  • double-large48
  • e-double-large64
  • double-large64
  • e-double-large96
  • double-large96
  • triple-large32
  • triple-large48
  • triple-large64
  • triple-large96
  • triple-large128
  • quad-large64
  • quad-large96
  • quad-large128
  • septa-large128
Default: mini
Placement.AvailabilityZone string ゾーン情報
Default: ニフクラが決定
Monitoring.Enabled string ※指定不可
SubnetId string ※指定不可
InstanceInitiatedShutdownBehavior string ※指定不可
PrivateIpAddress string ※指定不可
DiskImage.n.Image.Format string ※指定不可
DiskImage.n.Image.Bytes integer ※指定不可
DiskImage.n.Image.ImportManifestUrl string ※指定不可
DiskImage.n.Description string ※指定不可
DiskImage.n.Volume.Size integer ※指定不可
Platform string ※指定不可
InstanceId string サーバー名
Ovf string OVFデータ
AccountingType string 利用料金タイプ
値:
  • 1 (月額課金)
  • 2 (従量課金)
Default: 2
IpType string IPアドレスのタイプ
値:
  • static (固定)
  • elastic (付替)
  • none (グローバルIPなし)
Default: static (NetworkInterfaceの定義が指定されていれば、NetworkInterfaceの定義を適用)
PublicIp string 付替グローバルIPアドレス
○ (IpTypeがelasticの場合)
NetworkInterface.n.DeviceIndex integer ※指定不可
NetworkInterface.n.SecurityGroupId.n string ※指定不可
NetworkInterface.n.NetworkId string ネットワークID
使用可能文字: net-COMMON_GLOBAL(共通グローバル)、net-COMMON_PRIVATE(共通プライベート)、プライベートLAN のネットワークID
○ (ネットワーク名といずれか)
NetworkInterface.n.NetworkName string ネットワーク名(共通グローバルと共通プライベートはネットワークIDを指定)
○ (ネットワークIDといずれか)
NetworkInterface.n.IpAddress string

IPアドレス

1)指定されたネットワークが共通グローバル 値 : 付替グローバルIPアドレス
Default : DHCPによるIPアドレス自動発行
2)指定されたネットワークが共通プライベート 値 : 付替プライベートIPアドレス
Default : DHCPによるIPアドレス自動発行
3)指定されたネットワークがプライベートLANでDHCPが有効化されている 値 : IPアドレス | static(手動化)
Default : DHCPによるIPアドレス自動発行
4)指定されたネットワークがプライベートLANでDHCPが無効化されている 値 : static(手動化)

応答フィールド

フィールド (項目) 説明
ImportInstanceResponse - ImportInstanceResponse レスポンス
conversionTask - 変換タスク
conversionTaskId string タスクID
expirationTime string タスク破棄時間
importInstance - インポートするサーバー情報
volumes - インポートサーバーの詳細情報
item - インポートサーバーの詳細情報
bytesConverted integer 変換済みサイズ
値:
  • 0
availabilityZone string ゾーン情報
image - インポートイメージ詳細
format string イメージフォーマット
値:
  • VMDK
size integer インポートイメージサイズ
単位: Byte
status string 変換タスクのステータス
値:
  • active
instanceId string サーバー名
instanceUniqueId string サーバーユニークID
description string メモ情報
state string ※空を返却
networkInterfaceSet - ネットワークインターフェース情報セット
item - ネットワークインターフェース情報
networkInterfaceId string ※空を返却
subnetId string ※空を返却
vpcId string ※空を返却
description string ※空を返却
ownerId string ※空を返却
niftyNetworkId string ネットワークユニークID
niftyNetworkName string ネットワーク名
status string ネットワークインタフェースのステータス
値:
  • processing(処理中)
privateDnsName string ※空を返却
sourceDestCheck string ※空を返却
groupSet string ファイアウォール情報 ※空を返却
attachment - ネットワークインターフェースの接続情報
attachmentID string ※空を返却
deviceIndex integer デバイス番号
値:
  • 0
status string 接続状態
値:
  • processing
attachTime timestamp ※空を返却
deleteOnTermination boolean サーバー削除時のネットワークインターフェース消去
値:
  • true(消去)
association - ネットワークインタフェースに関連付けられているパブリックIP(固定グローバルIPアドレス、付替IPアドレス)の情報
publicDnsName string ※空を返却
ipOwnerId string ※空を返却
privateIpAddressesSet string ※空を返却

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/
  ?Action=ImportInstance
  &Ovf=<?xml version='1.0' encoding='UTF-8'?><ovf:Enve…</ovf:Envelope>
  &CommonParams

  

応答サンプル

    <ImportInstanceResponse xmlns="https://computing.api.nifcloud.com/api/">
  <conversionTask>
    <conversionTaskId>f7d9241b-7978-4885-8def-8ec70c08571b</conversionTaskId>
    <expirationTime>2020-08-09T16:41:20.208+09:00</expirationTime>
    <importInstance>
      <volumes>
        <item>
          <bytesConverted>0</bytesConverted>
          <availabilityZone>east-11</availabilityZone>
          <image>
            <format>VMDK</format>
            <size>845350400</size>
          </image>
          <status>active</status>
        </item>
      </volumes>
      <instanceId>importTest02</instanceId>
      <instanceUniqueId>i-000bau08</instanceUniqueId>
      <description>Memo</description>
    </importInstance>
    <state></state>
    <networkInterfaceSet>
      <item>
        <networkInterfaceId></networkInterfaceId>
        <subnetId></subnetId>
        <vpcId></vpcId>
        <description></description>
        <ownerId></ownerId>
        <niftyNetworkId>net-COMMON_GLOBAL</niftyNetworkId>
        <status>processing</status>
        <privateDnsName></privateDnsName>
        <sourceDestCheck></sourceDestCheck>
        <groupSet></groupSet>
        <attachment>
          <attachmentID></attachmentID>
          <deviceIndex>0</deviceIndex>
          <status>attached</status>
          <attachTime></attachTime>
          <deleteOnTermination>true</deleteOnTermination>
        </attachment>
        <association>
          <publicDnsName></publicDnsName>
          <ipOwnerId></ipOwnerId>
        </association>
        <privateIpAddressesSet></privateIpAddressesSet>
      </item>
      <item>
        <networkInterfaceId></networkInterfaceId>
        <subnetId></subnetId>
        <vpcId></vpcId>
        <description></description>
        <ownerId></ownerId>
        <niftyNetworkId>net-COMMON_PRIVATE</niftyNetworkId>
        <status>processing</status>
        <privateDnsName></privateDnsName>
        <sourceDestCheck></sourceDestCheck>
        <groupSet></groupSet>
        <attachment>
          <attachmentID></attachmentID>
          <deviceIndex>0</deviceIndex>
          <status>attached</status>
          <attachTime></attachTime>
          <deleteOnTermination>true</deleteOnTermination>
        </attachment>
        <privateIpAddressesSet></privateIpAddressesSet>
      </item>
    </networkInterfaceSet>
  </conversionTask>
</ImportInstanceResponse>

  

ニフクラ サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフクラ公式フェイスブックページ
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2021年9月17日時点の情報です。

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