ImportInstance
処理概要
指定したOVFファイルの情報に基づいて、サーバーインポートを予約します。
1回のリクエストで1台のサーバーが予約可能です。
イメージ（VMDKファイル）は、別途アップロード領域へアップロードしてください（このAPIのレスポンスに含まれるタスクIDを指定します）。
サーバーの作成には、時間がかかることがあります。
API「DescribeInstances」のレスポンス値「instanceState」でサーバーのステータスを確認できます。
インポートしたサーバーは通常ほかのサーバー作成と同様に課金されますが、ニフクラの基本ディスク容量（Linux:30GB、Windows:80GB）を超えるディスクを持つ場合は100GB単位で追加料金が発生します。
ニフクラがサポートしないOS製品である、複数OSのサーバーであるなどの場合はインポートできず、エラーが返されます。
APIのパラメータに「IpType」を指定して、かつ「NetworkInterface.n.NetworkId」に共通グローバルを指定した場合、エラーが返されます。
インポートしたサーバーは、APIからの削除が可能です。
APIからの削除を禁止したい場合は、インポート完了後にAPI「ModifyInstanceAttribute」を実行してください。
指定するパラメーター
| パラメーター | 説明 | 必須 | サンプル値 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Description | メモ Type : String |
||||||||||
| Architecture | ※指定不可 Type : String |
||||||||||
| SecurityGroup.n | 適用するファイアウォールグループ名 Type : String |
group1 | |||||||||
| UserData | ※指定不可 Type : String |
||||||||||
| InstanceType | サーバータイプ Type : 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-large48 | triple-large64 | triple-large96 | triple-large128 | quad-large128 Default : mini |
||||||||||
| Placement.AvailabilityZone | ゾーン情報 Type : String Default : ニフクラが決定 |
||||||||||
| Monitoring.Enabled | ※指定不可 Type : String |
||||||||||
| SubnetId | ※指定不可 Type : String |
||||||||||
| InstanceInitiatedShutdownBehavior | ※指定不可 Type : String |
||||||||||
| PrivateIpAddress | ※指定不可 Type : String |
||||||||||
| DiskImage.n.Image.Format | ※指定不可 Type : String 値 : vmdk |
||||||||||
| DiskImage.n.Image.Bytes | ※指定不可 Type : Long |
||||||||||
| DiskImage.n.Image.ImportManifestUrl | ※指定不可 Type : String |
||||||||||
| DiskImage.n.Description | ※指定不可 Type : String |
||||||||||
| DiskImage.n.Volume.Size | ※指定不可 Type : Integer |
||||||||||
| Platform | ※指定不可 Type : String |
||||||||||
| InstanceId | サーバー名 Type : String |
server04 | |||||||||
| Ovf | OVFデータ Type : String |
○ | |||||||||
| AccountingType | 利用料金タイプ Type : String 値 : 1 (月額課金) | 2 (従量課金) Default : 2 |
||||||||||
| IpType | IPアドレスのタイプ Type : String 値 : static (固定) | elastic (付替)| none(グローバルIPなし) Default : static (NetworkInterfaceの定義が指定されていれば、NetworkInterfaceの定義を適用) |
||||||||||
| PublicIp | 付替グローバルIPアドレス Type : String |
○ （IpTypeがelasticの場合） |
|||||||||
| NetworkInterface.n.DeviceIndex | ※指定不可 Type : Integer |
||||||||||
| NetworkInterface.n.SecurityGroupId.n | ※指定不可 Type : String |
||||||||||
| NetworkInterface.n.NetworkId | ネットワークID Type : String 値 : net-COMMON_GLOBAL (共通グローバル) | net-COMMON_PRIVATE (共通プライベート) | プライベートLANのネットワークID |
○（ネットワーク名といずれか） | |||||||||
| NetworkInterface.n.NetworkName | ネットワーク名（共通グローバルと共通プライベートはネットワークIDを指定） Type : String |
○（ネットワークIDといずれか） | |||||||||
| NetworkInterface.n.IpAddress | IPアドレス
|
応答フィールド
| フィールド(項目) | 説明 | サンプル値 |
|---|---|---|
| ImportInstanceResponse | ImportInstanceResponse レスポンス Type : ImportInstanceResponseType Ancestor : なし Children : conversionTask |
|
| conversionTask | 変換タスク Type : ConversionTaskType Ancestor : ImportInstanceResponse Children : conversionTaskId, expirationTime, importInstance, state, statusMessage, tagSet, networkInterfaceSet |
|
| conversionTaskId | タスクID Type : xsd:string Ancestor : conversionTask Children : なし |
d6f1ba72-0a76-4b1d-8421-a4f6089d3d7a |
| expirationTime | タスク破棄時間 Type : xsd:string Ancestor : conversionTask Children : なし |
2012-02-19T18:50:32.986+09:00 |
| importInstance | インポートするサーバー情報 Type : ImportInstanceTaskDetailsType Ancestor : conversionTask Children : volumes, instanceId, instanceUniqueId, platform, description |
|
| volumes | サーバー情報 Type : ImportInstanceVolumeDetailSetType Ancestor : importInstance Children : item |
|
| item | サーバー情報 Type : ImportInstanceVolumeDetailItemType Ancestor : volumes Children : bytesConverted, availabilityZone, image, description, volume, status, statusMessage |
|
| bytesConverted | 変換済みサイズ Type : xsd:long 値 : 0 Ancestor : item Children : なし |
0 |
| availabilityZone | ゾーン情報 Type : xsd:string Ancestor : item Children : なし |
east-11 |
| image | イメージ詳細 Type : DiskImageDescriptionType Ancestor : item Children : format, size, importManifestUrl, checksum |
|
| format | イメージフォーマット Type : xsd:string 値 : "VMDK" Ancestor : image Children : なし |
VMDK |
| size | イメージサイズ Type : xsd:long Ancestor : image Children : なし |
|
| importManifestUrl | ※返却値なし Type : xsd:string Ancestor : image Children : なし |
|
| checksum | ※返却値なし Type : xsd:int Ancestor : image Children : なし |
|
| description | ※空を返却 Type : xsd:string Ancestor : item Children : なし |
|
| volume | ※返却値なし Type : DiskImageVolumeDescriptionType Ancestor : item Children : size, id |
|
| size | ※返却値なし Type : xsd:integer Ancestor : volume Children : なし |
|
| id | ※返却値なし Type : xsd:string Ancestor : volume Children : なし |
|
| status | ステータス Type : xsd:string 値 : "active" Ancestor : item Children : なし |
active |
| statusMessage | ※返却値なし Type : xsd:string Ancestor : item Children : なし |
|
| instanceId | サーバー名 Type : xsd:string Ancestor : importInstance Children : なし |
server04 |
| instanceUniqueId | サーバーユニークID Type : xsd:string Ancestor : importInstance Children : なし |
i-abfd1234 |
| platform | ※返却値なし Type : xsd:string Ancestor : importInstance Children : なし |
|
| description | ※返却値なし Type : xsd:string Ancestor : importInstance Children : なし |
|
| state | ※返却値なし Type : xsd:string Ancestor : conversionTask Children : なし |
|
| statusMessage | ※返却値なし Type : xsd:string Ancestor : conversionTask Children : なし |
|
| tagSet | ※返却値なし Type : ResourceTagSetType Ancestor : conversionTask Children : item |
|
| item | ※返却値なし Type : ResourceTagSetItemType Ancestor : tagSet Children : key, value |
|
| key | ※返却値なし Type : xsd:string Ancestor : item Children : なし |
|
| value | ※返却値なし Type : xsd:string Ancestor : item Children : なし |
|
| networkInterfaceSet | ネットワークインターフェース情報セット Type : NetworkInterfaceSetType Ancestor : item Children : item |
|
| item | ネットワークインターフェース情報 Type : InstanceNetworkInterfaceSetItemType Ancestor : networkInterfaceSet Children :networkInterfaceId, subnetId, vpcId, description, ownerId, niftyNetworkId, niftyNetworkName, status, macAddress, privateIpAddress, privateIpAddressV6, privateDnsName, sourceDestCheck, groupSet, attachment, association, privateIpAddressesSet |
|
| networkInterfaceId | ※空を返却 Type : xsd:string Ancestor : item Children : なし |
|
| subnetId | ※空を返却 Type : xsd:string Ancestor : item Children : なし |
|
| vpcId | ※空を返却 Type : xsd:string Ancestor : item Children : なし |
|
| description | ※空を返却 Type : xsd:string Ancestor : item Children : なし |
|
| ownerId | ※空を返却 Type : xsd:string Ancestor : item Children : なし |
|
| niftyNetworkId | ネットワークユニークID Type : xsd:string Ancestor : item Children : なし |
|
| niftyNetworkName | ネットワーク名 Type : xsd:string Ancestor : item Children : なし |
|
| status | ネットワークインターフェースのステータス Type : xsd:string 値 : available(利用可能) | in-use(使用中) | processing (処理中) Ancestor : item Children : なし |
|
| macAddress | ネットワークインターフェースのMACアドレス Type : xsd:string Ancestor : item Children : なし |
|
| privateIpAddress | プライベートIPアドレス or プライベート付替IPアドレス (グローバルで無いときのみ) Type : xsd:string Ancestor : item Children : なし |
|
| privateIpAddressV6 | プライベートIPアドレス（IPv6） Type : xsd:string Ancestor : item Children : なし |
|
| privateDnsName | ※空を返却 Type : xsd:string Ancestor : item Children : なし |
|
| sourceDestCheck | ソース Type : xsd:string Ancestor : item Children : なし |
|
| groupSet | 適用しているファイアウォール情報 ※空を返却 Type : GroupSetType Ancestor : item Children : item |
|
| item | ファイアウォール情報 ※空を返却 Type : GroupItemType Ancestor : groupSet Children : groupId |
|
| groupId | ファイアウォールグループ名 Type : xsd:string Ancestor : item Children : なし |
|
| attachment | ネットワークインターフェースの接続情報 Type : InstanceNetworkInterfaceAttachmentType Ancestor : item Children : attachmentID, deviceIndex, status, attachTime, deleteOnTermination |
|
| attachmentID | ※空を返却 Type : xsd:string Ancestor : attachment Children : なし |
|
| deviceIndex | デバイス番号 Type : xsd:integer Ancestor : attachment Children : なし |
|
| status | 接続状態 Type : xsd:string Ancestor : attachment Children : なし |
|
| attachTime | ※空を返却 Type : xsd:Calendar Ancestor : attachment Children : なし |
|
| deleteOnTermination | サーバー削除時のネットワークインターフェース消去 Type : xsd:boolean 値 : true(消去) Ancestor : attachment Children : なし |
|
| association | ネットワークインターフェースに関連付けられているパブリックIP（固定グローバルIPアドレス、付替IPアドレス）の情報 Type : InstanceNetworkInterfaceAssociationType Ancestor : item Children : publicIp,publicIpV6,publicDnsName,ipOwnerId |
|
| publicIp | グローバルIPアドレスまたはグローバル付替IPアドレス Type : xsd:string Ancestor : association Children : なし |
|
| publicIpV6 | グローバルIPアドレス(IPv6) Type : xsd:string Ancestor : association Children : なし |
|
| publicDnsName | ※空を返却 Type : xsd:string Ancestor : association Children : なし |
|
| ipOwnerId | ※空を返却 Type : xsd:string Ancestor : association Children : なし |
|
| privateIpAddressesSet | ※空を返却 Type : InstancePrivateIpAddressesSetType Ancestor : item Children : item |
|
| item | インスタンスに付属するプライベートIP Type : InstancePrivateIpAddressesSetItemType Ancestor : privateIpAddressesSet Children : association, primary, privateDnsName, privateIpAddress |
|
| association | 付替IPアドレスの関連付け情報 Type : InstanceNetworkInterfaceAssociation Ancestor : item Children : ipOwnerId, publicDnsName, publicIp |
|
| ipOwnerId | 付替IPアドレスのオーナーID Type : xsd:string Ancestor : association Children : なし |
|
| publicDnsName | パブリックDNS名 Type : xsd:string Ancestor : association Children : なし |
|
| publicIp | ネットワークインターフェースのパブリックIP Type : xsd:string Ancestor : association Children : なし |
|
| primary | ネットワークインターフェースのプライマリープライベートIP情報 Type : xsd: Boolean Ancestor : item Children : なし |
|
| privateDnsName | プライベートDNS名 Type : xsd:string Ancestor : item Children : なし |
|
| privateIpAddress | ネットワークインターフェースのプライベートIP Type : xsd:string Ancestor : item Children : なし |
|
| networkInterfaceSet | ネットワークインターフェースNetworkInterface情報セット Type : NetworkInterfaceSetType Ancestor : item Children : item |
|
| item | ネットワークインターフェースNetworkInterface情報 Type : InstanceNetworkInterfaceSetItemType Ancestor : networkInterfaceSet Children : networkInterfaceId,subnetId,vpcId,description,ownerId, niftyNetworkId,niftyNetworkName,status,macAddress,privateIpAddress,privateIpAddressV6,privateDnsName,sourceDestCheck, groupSet,attachment,association,privateIpAddressesSet |
|
| networkInterfaceId | ※空を返却 Type : xsd:string Ancestor : item Children : なし |
|
| subnetId | ※空を返却 Type : xsd:string Ancestor : item Children : なし |
|
| vpcId | ※空を返却 Type : xsd:string Ancestor : item Children : なし |
|
| description | ※空を返却 Type : xsd:string Ancestor : item Children : なし |
|
| ownerId | ※空を返却 Type : xsd:string Ancestor : item Children : なし |
|
| niftyNetworkId | ネットワークユニークID Type : xsd:string Ancestor : item Children : なし |
|
| niftyNetworkName | ネットワーク名 Type : xsd:string Ancestor : item Children : なし |
|
| status | ネットワークインタフェースのステータス Type : xsd:string 値 : available(接続中) | in-use(使用中) | processing(処理中) Ancestor : item Children : なし |
|
| macAddress | ネットワークインタフェースのMACアドレス Type : xsd:string Ancestor : item Children : なし |
|
| privateIpAddress | プライベートIPアドレスまたはプライベート付替IPアドレス（グローバルでないときのみ） Type : xsd:string Ancestor : item Children : なし |
|
| privateIpAddressV6 | プライベートIPアドレス（IPv6） Type : xsd:string Ancestor : item Children : なし |
|
| privateDnsName | ※空を返却 Type : xsd:string Ancestor : item Children : なし |
|
| sourceDestCheck | ※空を返却 Type : xsd:string Ancestor : item Children : なし |
|
| groupSetItem | ファイアウォール情報 ※空を返却 Type : GroupItemType Ancestor : item Children : groupId |
|
| groupId | グループID Type : xsd:string Ancestor : groupSetItem Children : なし |
|
| attachment | ネットワークインターフェースの接続情報 Type : InstanceNetworkInterfaceAttachmentType Ancestor : item Children : attachmentID,deviceIndex,status,attachTime,deleteOnTermination |
|
| attachmentID | ※空を返却 Type : xsd:string Ancestor : attachment Children : なし |
|
| deviceIndex | デバイス番号 Type : xsd:integer Ancestor : attachment Children : なし |
|
| status | 接続状態 Type : xsd:string Ancestor : attachment Children : なし |
|
| attachTime | ※空を返却 Type : xsd:Calendar Ancestor : attachment Children : なし |
|
| deleteOnTermination | サーバー削除時のネットワークインターフェース消去 Type : xsd:boolean 値 : true(消去) Ancestor : attachment Children : なし |
|
| association | ネットワークインタフェースに関連付けられているパブリックIP（固定グローバルIPアドレス、付替IPアドレス）の情報 Type : InstanceNetworkInterfaceAssociationType Ancestor : item Children : publicIp,publicIpV6,publicDnsName,ipOwnerId |
|
| publicIp | グローバルIPアドレスまたはグローバル付替IPアドレス Type : xsd:string Ancestor : association Children : なし |
|
| publicIpV6 | グローバルIPアドレス(IPv6) Type : xsd:string Ancestor : association Children : なし |
|
| publicDnsName | ※空を返却 Type : xsd:string Ancestor : association Children : なし |
|
| ipOwnerId | ※空を返却 Type : xsd:string Ancestor : association Children : なし |
|
| privateIpAddressesSet | ※空を返却 Type : InstancePrivateIpAddressesSetType Ancestor : item Children : item |
|
| item | インスタンスに付属するプライベートIP Type : InstancePrivateIpAddressesSetItemType Ancestor : privateIpAddressesSet Children : association, primary, privateDnsName, privateIpAddress |
|
| association | 付替IPアドレスの関連付け情報 Type : InstanceNetworkInterfaceAssociation Ancestor : item Children : ipOwnerId, publicDnsName, publicIp |
|
| ipOwnerId | 付替IPアドレスのオーナーID Type : xsd:string Ancestor : association Children : なし |
|
| publicDnsName | パブリックDNS名 Type : xsd:string Ancestor : association Children : なし |
|
| publicIp | ネットワークインターフェースのパブリックIP Type : xsd:string Ancestor : association Children : なし |
|
| primary | ネットワークインターフェースのプライマリープライベートIP情報 Type : xsd: Boolean Ancestor : item Children : なし |
|
| privateDnsName | プライベートDNS名 Type : xsd:string Ancestor : item Children : なし |
|
| privateIpAddress | ネットワークインターフェースのプライベートIP Type : xsd:string Ancestor : item Children : なし |
リクエストサンプル
https://jp-east-1.computing.api.nifcloud.com/api/?Action=ImportInstance&Ovf=<?xml version='1.0' encoding='UTF-8'?><ovf:Enve…</ovf:Envelope>l;&CommonParams応答サンプル
<ImportInstanceResponse xmlns="https://cp.cloud.nifty.com/api/">
<conversionTask>
<conversionTaskId>import-n-sd-093rar3gl4</conversionTaskId>
<expirationTime>2012-10-13T19:17:28.799+09:00</expirationTime>
<importInstance>
<volumes>
<item>
<bytesConverted>0</bytesConverted>
<availabilityZone>east-11</availabilityZone>
<image>
<format>VMDK</format>
<size>266189212314</size>
</image>
<description/>
<status>active</status>
<statusMessage/>
</item>
</volumes>
<instanceId>server01</instanceId>
<instanceUniqueId>i-abfd1234</instanceUniqueId>
<description>memo</description>
<networkInterfaceSet>
<item>
<networkInterfaceId/>
<subnetId/>
<vpcId/>
<description/>
<ownerId/>
<niftyNetworkId>net-COMMON_GLOBAL</niftyNetworkId>
<niftyNetworkName/>
<status>available</status>
<macAddress>07:00:30:1B:92:44</macAddress>
<privateDnsName/>
<sourceDestCheck/>
<groupSet/>
<attachment>
<attachmentID/>
<deviceIndex>0</deviceIndex>
<status>attached</status>
<attachTime/>
<deleteOnTermination>true</deleteOnTermination>
</attachment>
<association/>
<privateIpAddressesSet/>
</item>
<item>
<networkInterfaceId/>
<subnetId/>
<vpcId/>
<description/>
<ownerId/>
<niftyNetworkId>net-COMMON_PRIVATE</niftyNetworkId>
<niftyNetworkName/>
<status>available</status>
<macAddress>07:00:30:1B:92:45</macAddress>
<privateIpAddress/>
<privateIpAddressV6/>
<privateDnsName/>
<sourceDestCheck/>
<groupSet/>
<attachment>
<attachmentID/>
<deviceIndex>0</deviceIndex>
<status>attaching</status>
<attachTime/>
<deleteOnTermination>true</deleteOnTermination>
</attachment>
<association/>
</item>
</networkInterfaceSet>
</importInstance>
</conversionTask>
</ImportInstanceResponse>
