RunInstances
処理概要
サーバーを新規作成します。1回のリクエストで、1つのサーバーを作成できます。
サーバーの作成には、時間がかかることがあります。このAPIのレスポンス「instanceState」を確認し「pending」が返ってきた、またはタイムアウトした場合は、API「DescribeInstances」のレスポンス値「instanceState」でサーバーのステータスを確認できます。
APIのパラメーターに「IpType」、「NetworkInterface.n.NetworkId」両方を指定しなかった場合、「IpType」パラメーターのdefault値が適用されます。
UserDataを指定してリクエストする場合は、POSTのみの対応となりますので、ご注意ください。
指定するパラメーター
| パラメーター | 型 | 説明 | 必須 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| ImageId | string |
OSイメージID |
○ | ||||||||
| MinCount | integer |
※指定不可 |
|||||||||
| MaxCount | integer |
※指定不可 |
|||||||||
| KeyName | string |
SSHキー名 |
○ (スタンダードイメージのWindows以外) | ||||||||
| SecurityGroup.n | string |
適用するファイアウォールグループ名 |
|||||||||
| UserData | string |
サーバー起動時スクリプト |
|||||||||
| UserData.Encoding | string |
サーバー起動時スクリプトのエンコード Default: base64 使用可能文字: プレーンテキストの場合は空、base64の場合はbase64 |
|||||||||
| AddressingType | string |
※指定不可 |
|||||||||
| InstanceType | string |
サーバータイプ 値:
備考: h2r,e2r,c2rについては、対象でないリージョンで指定した場合にエラーとなります |
|||||||||
| Placement.GroupName | string |
※指定不可 |
|||||||||
| Placement.AvailabilityZone | string |
ゾーン情報 Default: ニフクラが決定 |
|||||||||
| KernelId | string |
※指定不可 |
|||||||||
| RamdiskId | string |
※指定不可 |
|||||||||
| BlockDeviceMapping.n.DeviceName | string |
※指定不可 |
|||||||||
| BlockDeviceMapping.n.VirtualName | string |
※指定不可 |
|||||||||
| BlockDeviceMapping.n.Ebs.SnapshotId | string |
※指定不可 |
|||||||||
| BlockDeviceMapping.n.Ebs.VolumeSize | integer |
※指定不可 |
|||||||||
| BlockDeviceMapping.n.Ebs.DeleteOnTermination | boolean |
※指定不可 |
|||||||||
| BlockDeviceMapping.n.Ebs.NoDevice | boolean |
※指定不可 |
|||||||||
| Monitoring.Enabled | boolean |
※指定不可 Default: false (基本監視の設定なし) |
|||||||||
| SubnetId | string |
※指定不可 |
|||||||||
| DisableApiTermination | boolean |
APIからのサーバー削除の可否 値:
|
|||||||||
| InstanceInitiatedShutdownBehavior | string |
※指定不可 |
|||||||||
| AccountingType | string |
利用料金タイプ 値:
|
|||||||||
| InstanceId | string |
サーバー名 Default: 英数8文字 (システム発行) |
|||||||||
| Admin | string |
管理者アカウント ※Windows OS選択時のみ必須 |
○ (スタンダードイメージのWindows) | ||||||||
| Password | string |
管理者アカウントパスワード |
○ (スタンダードイメージのWindows) | ||||||||
| IpType | string |
IPアドレスのタイプ 値:
|
|||||||||
| PublicIp | string |
付替グローバルIPアドレス |
○ (IpTypeがelasticの場合) | ||||||||
| Agreement | boolean |
Red Hat Enterprise Linux 5.8 64bit / 6.3 64bit、またはSPLAサーバーを指定した場合の同意 値:
|
|||||||||
| Description | string |
メモ |
|||||||||
| 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といずれか) | ||||||||
| NetworkInterface.n.IpAddress | string |
IPアドレス
|
|||||||||
| License.n.LicenseName | string |
ライセンス種別 値:
|
|||||||||
| License.n.LicenseNum | string |
ライセンス数 使用可能文字: 1〜200の数値 |
応答フィールド
| フィールド (項目) | 型 | 説明 |
|---|---|---|
| RunInstancesResponse | - |
RunInstancesレスポンス |
| ␣requestId | string |
リクエスト識別子 |
| ␣reservationId | string |
※空を返却 |
| ␣ownerId | string |
※空を返却 |
| ␣groupSet | - |
適用したファイアウォールグループ情報 |
| ␣␣item | - |
ファイアウォールグループ情報 |
| ␣␣␣groupId | string |
ファイアウォールグループ名 |
| ␣instancesSet | - |
作成に成功したサーバーの情報セット |
| ␣␣item | - |
作成に成功したサーバーの情報 |
| ␣␣␣instanceId | string |
サーバー名 |
| ␣␣␣instanceUniqueId | string |
サーバーユニークID |
| ␣␣␣imageId | string |
OSイメージ名 |
| ␣␣␣instanceState | - |
サーバーの現在のステータス |
| ␣␣␣␣code | integer |
現在のステータスコード (A 16-bit unsigned) 備考: 返却値 0,16,80 |
| ␣␣␣␣name | string |
現在のステータス名 値:
|
| ␣␣␣privateDnsName | string |
プライベートIPアドレス |
| ␣␣␣dnsName | string |
グローバルIPアドレス |
| ␣␣␣reason | string |
異常時のエラーコード ※instanceStateで異常が発生した場合に返される。 |
| ␣␣␣keyName | string |
SSHキー名 |
| ␣␣␣admin | string |
管理者アカウント |
| ␣␣␣instanceType | string |
サーバータイプ 値:
|
| ␣␣␣launchTime | timestamp |
サーバーの作成日時 値:
|
| ␣␣␣placement | - |
ゾーン情報 |
| ␣␣␣␣availabilityZone | string |
ゾーン情報 |
| ␣␣␣platform | string |
OS情報 値:
|
| ␣␣␣monitoring | - |
監視情報 |
| ␣␣␣␣state | string |
監視ステータス 値:
|
| ␣␣␣privateIpAddress | string |
プライベートIPアドレス |
| ␣␣␣ipAddress | string |
グローバルIPアドレス |
| ␣␣␣privateIpAddressV6 | string |
※空を返却 プライベートIPアドレス（IPv6） |
| ␣␣␣ipAddressV6 | string |
※空を返却 グローバルIPアドレス（IPv6） |
| ␣␣␣architecture | string |
OSイメージのアーキテクチャ 値:
|
| ␣␣␣rootDeviceType | string |
ディスクの種類 値:
|
| ␣␣␣blockDeviceMapping | - |
接続しているディスクの情報セット |
| ␣␣␣␣item | - |
接続しているディスクの情報 |
| ␣␣␣␣␣deviceName | string |
ディスクの接続デバイス 値:
|
| ␣␣␣␣␣ebs | - |
接続しているディスクの詳細情報 |
| ␣␣␣␣␣␣volumeId | string |
ディスク名 |
| ␣␣␣␣␣␣volumeUniqueId | string |
ディスクユニークID ※空を返却 |
| ␣␣␣␣␣␣status | string |
接続ステータス |
| ␣␣␣␣␣␣deleteOnTermination | string |
サーバー削除時のディスク消去 値:
|
| ␣␣␣accountingType | string |
利用料金タイプ 値:
|
| ␣␣␣ipType | string |
グローバルIPアドレスのタイプ 値:
|
| ␣␣␣niftyPrivateIpType | string |
プライベートIPアドレスのタイプ 値:
|
| ␣␣␣description | string |
メモ |
| ␣␣␣networkInterfaceSet | - |
ネットワークインターフェース情報セット |
| ␣␣␣␣item | - |
ネットワークインターフェース情報 |
| ␣␣␣␣␣networkInterfaceId | string |
※空を返却 |
| ␣␣␣␣␣subnetId | string |
※空を返却 |
| ␣␣␣␣␣vpcId | string |
※空を返却 |
| ␣␣␣␣␣description | string |
※空を返却 |
| ␣␣␣␣␣ownerId | string |
※空を返却 |
| ␣␣␣␣␣niftyNetworkId | string |
ネットワークユニークID |
| ␣␣␣␣␣niftyNetworkName | string |
ネットワーク名 |
| ␣␣␣␣␣status | string |
ネットワークインターフェースのステータス 値:
|
| ␣␣␣␣␣privateDnsName | string |
※空を返却 |
| ␣␣␣␣␣sourceDestCheck | string |
※空を返却 |
| ␣␣␣␣␣groupSet | - |
適用しているファイアウォール情報 ※空を返却 |
| ␣␣␣␣␣␣item | - |
ファイアウォール情報 |
| ␣␣␣␣␣␣␣groupId | string |
ファイアウォールグループ名 |
| ␣␣␣␣␣attachment | - |
ネットワークインターフェースの接続情報 |
| ␣␣␣␣␣␣attachmentID | string |
※空を返却 |
| ␣␣␣␣␣␣deviceIndex | string |
デバイス番号 |
| ␣␣␣␣␣␣status | string |
接続状態 |
| ␣␣␣␣␣␣attachTime | string |
※空を返却 |
| ␣␣␣␣␣␣deleteOnTermination | string |
サーバー削除時のネットワークインターフェース消去 値:
|
| ␣␣␣␣␣association | - |
ネットワークインターフェースに関連付けられているパブリックIP（固定グローバルIPアドレス、付替IPアドレス）の情報 |
| ␣␣␣␣␣␣publicDnsName | string |
※空を返却 |
| ␣␣␣␣␣␣ipOwnerId | string |
※空を返却 |
| ␣␣␣␣␣privateIpAddressesSet | - |
※空を返却 |
| ␣␣␣␣␣␣item | - |
インスタンスに付属するプライベートIP |
| ␣␣␣␣␣␣␣association | - |
付替IPアドレスの関連付け情報 |
| ␣␣␣␣␣␣␣␣ipOwnerId | string |
付替IPアドレスのオーナーID |
| ␣␣␣␣␣␣␣␣publicDnsName | string |
パブリックDNS名 |
| ␣␣␣␣␣␣␣␣publicIp | string |
ネットワークインターフェースのパブリックIP |
| ␣␣␣␣␣␣␣primary | boolean |
ネットワークインターフェースのプライマリープライベートIP情報 |
| ␣␣␣␣␣␣␣privateDnsName | string |
プライベートDNS名 |
| ␣␣␣␣␣␣␣privateIpAddress | string |
ネットワークインターフェースのプライベートIP |
| ␣␣␣isoImage | - |
※空を返却 適用しているISOイメージの情報 |
| ␣␣␣␣item | - |
適用しているISOイメージの情報 |
| ␣␣␣␣␣isoImageId | string |
適用しているISOイメージユニークID |
| ␣␣␣␣␣isoImageName | string |
適用しているISOイメージ名 |
リクエストサンプル
https://jp-east-1.computing.api.nifcloud.com/api/
?Action=RunInstances
&ImageId=1
&KeyName=sshkey01
&InstanceType=medium
&InstanceId=server04
&Description=memo
&NetworkInterface.1.IpAddress=111.111.111.111
&NetworkInterface.1.NetworkId=net-COMMON_GLOBAL
&NetworkInterface.2.IpAddress=192.168.0.1
&NetworkInterface.2.NetworkName=network
&SecurityGroup.1=group
&CommonParams
応答サンプル
<RunInstancesResponse xmlns="https://computing.api.nifcloud.com/api/">
<requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
<reservationId></reservationId>
<ownerId></ownerId>
<groupSet>
<item>
<groupId>group</groupId>
</item>
</groupSet>
<instancesSet>
<item>
<instanceId>server04</instanceId>
<instanceUniqueId>i-efgh1234</instanceUniqueId>
<imageId>customimage</imageId>
<instanceState>
<code>0</code>
<name>pending</name>
</instanceState>
<privateDnsName>192.168.0.1</privateDnsName>
<dnsName>111.111.111.111</dnsName>
<admin></admin>
<instanceType>medium</instanceType>
<launchTime>2010-05-17T11:22:33.456+09:00</launchTime>
<placement>
<availabilityZone>east-11</availabilityZone>
</placement>
<platform>centos</platform>
<monitoring>
<state>monitoring-disable</state>
</monitoring>
<privateIpAddress>192.168.0.1</privateIpAddress>
<ipAddress>111.111.111.111</ipAddress>
<privateIpAddressV6></privateIpAddressV6>
<ipAddressV6></ipAddressV6>
<architecture>x86_64</architecture>
<rootDeviceType>disk</rootDeviceType>
<blockDeviceMapping>
<item>
<deviceName>SCSI (0:1)</deviceName>
<ebs>
<volumeId>disk0001</volumeId>
<volumeUniqueId/>
<status>attaching</status>
<deleteOnTermination>false</deleteOnTermination>
</ebs>
</item>
</blockDeviceMapping>
<accountingType>2</accountingType>
<ipType>elastic</ipType>
<niftyPrivateIpType>static</niftyPrivateIpType>
<description>memo</description>
<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-0glomv00</niftyNetworkId>
<niftyNetworkName>network</niftyNetworkName>
<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>
<isoImage/>
</item>
</instancesSet>
</RunInstancesResponse>
