本文へジャンプします。

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

nifty-import-instance

処理概要

API「ImportInstance」が実行されます。
また、VMDKファイルをアップロードインターフェースへ送信します。

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

no-uploadオプションを指定した場合、アップロードが中断した場合は、nifty-resume-importで再開してください。

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

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

ニフティクラウドがサポートしないOS製品である、複数OSのサーバーであるなどの場合はインポートできず、エラーが返されます。またファイアウォール機能を提供していない環境でファイアウォールグループを指定して実行した場合は、エラーが返されます。

インポート処理開始前にエラーが発生した場合、サーバーは削除されます。
インポート中にエラーが発生した場合、サーバーはその状態で残されます。コントロールパネル画面からエラーを回復してください。

オプション「--ip-type」を指定して、かつオプション「--network」に共通グローバルを指定した場合、エラーが返されます。

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

コマンド構文

nifty-import-instance VMDKファイルパス [オプション]

オプション

オプション 短縮 説明 必須
--instance-type サーバータイプ -t サーバータイプを指定します。
e-mini | mini | e-small | small | e-small2 | small2 | e-small4 | small4 | e-small8 | small8 | e-medium | medium | e-medium4 | medium4 | e-medium8 | medium8 | e-medium16 | medium16 | medium24 | e-large | large | e-large8 | large8 | e-large16 | large16 | e-large24 | large24 | e-large32 | large32 | e-extra-large16 | extra-large16 | e-extra-large24 | extra-large24 | e-extra-large32 | extra-large32 | e-double-large32 | double-large32 | e-double-large48 | double-large48 | e-double-large64 | double-large64 | e-double-large96 | double-large96
 
--group グループ名
[--group グループ名 ...]
-g ファイアウォールグループ名を指定します。  
--no-upload   ディスクイメージをアップロードせず、インポートタスクのみ作成します。
インポートタスクを完了するには、nifty-resume-importを利用します。
 
--instance-id サーバー名   サーバー名を指定します。  
--ovf OVFファイル名 -V OVFイメージのファイル名を指定します。
--accounting-type 利用料金タイプ   利用料金タイプを指定します。  
--ip-type IPアドレスタイプ   IPアドレスタイプを指定します。
static(固定化)| elastic(付替)| none(グローバルIPなし)
 
--availability-zone ZONE -z サーバーのゾーンを指定します。  
--upload-url URL   アップロード先のエンドポイントを指定します。  
--public-ip IPアドレス   付替グローバルIPアドレスを指定します。 (IPアドレスタイプがelasticのみ○)
--description DESCRIPTION   メモ情報を指定します。  
--network "network-id=value, network-name=value, ip-address=value", [ --network " network-id=value, network-name=value, ip-address=value]   サーバーに設定するネットワークID、ネットワーク名、IPアドレスを指定します。
(network-idとnetwork-nameはどちらか1つを指定します。)
  • network-id
    net-COMMON_GLOBAL (共通グローバル) | net-COMMON_PRIVATE (共通プライベート) | プライベートLANのネットワークID
  • ip-address
  • 1)指定されたネットワークが共通グローバル
    値 : 付替グローバルIPアドレス
    Default : DHCPによるIPアドレス自動発行
  • 2)指定されたネットワークが共通プライベート
    値 : 付替プライベートIPアドレス
    Default : DHCPによるIPアドレス自動発行
  • 3)指定されたネットワークがプライベートLANでDHCPが有効化されている
    値 : IPアドレス | static(手動化)
    Default : DHCPによるIPアドレス自動発行
  • 4)指定されたnetworkがプライベートLANでDHCPが無効化されている
    値 : static(手動化)
 

出力要素

※ニフティクラウドAPIの応答フィールド名を記述します。

  • タスクタイプ(IMPORTINSTANCE)
  • IDタイプ(DISKIMAGE)
  • IMPORTINSTANCE / conversionTaskId
  • IMPORTINSTANCE / expirationTime
  • IMPORTINSTANCE / instanceId
  • IMPORTINSTANCE / instanceUniqueId
  • IMPORTINSTANCE / description
  • DISKIMAGE / size
  • DISKIMAGE / volumeSize
  • DISKIMAGE / availabilityZone
  • DISKIMAGE / bytesConverted
  • DISKIMAGE / status
  • DISKIMAGE / statusMessage
  • NETWORK_INTERFACE / niftyNetworkId
  • NETWORK_INTERFACE / niftyNetworkName
  • NETWORK_INTERFACE / status
  • NETWORK_INTERFACE / macAddress
  • NETWORK_INTERFACE / privateIpAddress
  • NETWORK_INTERFACE / privateIpAddressV6
  • NETWORK_INTERFACE_ATTACHMENT / deviceIndex
  • NETWORK_INTERFACE_ATTACHMENT / status
  • NETWORK_INTERFACE_ATTACHMENT / deleteOnTermination
  • NETWORK_INTERFACE_ASSOCIATION / publicIp
  • NETWORK_INTERFACE_ASSOCIATION / publicIpV6
  • (対象ファイル情報)
  • (分割送信情報)
  • (アップロード進捗)
  • (平均速度)

実行サンプル

PROMPT>nifty-import-instance svimg.vmdk -t mini -V svref.ovf -g fwgroup01 --availability-zone east-11 --network “network-id=net-COMMON_GLOBAL” --network “network-id=net-COMMON_PRIVATE”
IMPORTINSTANCE import-1-1-1-1 2011-xx-xxT00:20:12+09:00   new-instance-01 i-abfd1234
DISKIMAGE 2656406016 0 east-11 4367650 active 
NETWORK_INTERFACE net-COMMON_GLOBAL available 00-00-00-00-00-00
NETWORK_INTERFACE_ATTACHMENT 0 attached true
NETWORK_INTERFACE_ASSOCIATION 172.16.13.10
NETWORK_INTERFACE net-COMMON_PRIVATE available 00-00-00-00-00-00 10.10.10.10
NETWORK_INTERFACE_ATTACHMENT 0 attaching true
Uploading svimg.vmdk
Uploading 2656406016 bytes across 254 parts
0% |--------------------------------------------------| 100%
|==================================================|
Done
Average speed was 5.359 MBps

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

APIメニュー

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

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