本文へジャンプします。

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

RunInstances

処理概要

サーバーを新規作成します。1回のリクエストで、1つのサーバーを作成できます。

サーバーの作成には、時間がかかることがあります。このAPIのレスポンス「instanceState」を確認し「pending」が返ってきた、タイムアウトした場合は、API「DescribeInstances」のレスポンス値「instanceState」でサーバーのステータスを確認できます。

APIのパラメータに「IpType」を指定して、かつ「NetworkInterface.n.NetworkId」に共通グローバルを指定した場合、エラーが返されます。

処理が失敗した場合、サーバーは作成されず、エラーが返されます。

指定するパラメーター

パラメーター 説明 必須 サンプル値
ImageId OSイメージID
Type : String
1
MinCount ※指定不可
Type : Integer
   
MaxCount ※指定不可
Type : Integer
   
KeyName SSHキー名
Type : String

(スタンダードイメージのWindows以外)
sshkey01
SecurityGroup.n 適用するファイアウォールグループ名
※ファイアウォール機能を提供していない環境の場合、指定不可(エラーが返ります)
Type : String
   
UserData サーバー起動時スクリプト
Type : String
   
UserData.Encoding サーバー起動時スクリプトのエンコード
Type: String
値: 空(プレーンテキスト) | base64
Default: base64
   
AddressingType ※指定不可
Type : String
   
InstanceType サーバータイプ
Type : String
値 : 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
Default : mini
  medium
Placement.GroupName ※指定不可
Type : String
   
Placement.AvailabilityZone ゾーン情報
Type : String
Default : ニフティクラウドが決定
   
KernelId ※指定不可
Type : String
   
RamdiskId ※指定不可
Type : String
   
BlockDeviceMapping .n.DeviceName ※指定不可
Type : String
   
BlockDeviceMapping .n.VirtualName ※指定不可
Type : String
   
BlockDeviceMapping .n.Ebs.SnapshotId ※指定不可
Type : String
   
BlockDeviceMapping .n.Ebs.VolumeSize ※指定不可
Type : Integer
   
BlockDeviceMapping .n.Ebs.DeleteOnTermination ※指定不可
Type : Boolean
   
BlockDeviceMapping .n.Ebs.NoDevice ※指定不可
Type : Boolean
   
Monitoring .Enabled ※指定不可
Type : Boolean
Default : false (基本監視の設定なし)
   
SubnetId ※指定不可
Type : String
   
DisableApiTermination APIからのサーバー削除の可否
Type : Boolean
値 : true (削除不可) | false (削除可)
Default : true (削除不可)
   
InstanceInitiatedShutdownBehavior ※指定不可
Type : String
   
AccountingType 利用料金タイプ
Type : String
値 : 1 (月額課金) | 2 (従量課金)
Default : 2 (従量課金)
   
InstanceId サーバー名
Type : String
Default : 英数8文字 (システム発行)
  server04
Admin 管理者アカウント
※Windows OS選択時のみ必須
Type : String

(スタンダードイメージのWindows)
 
Password root / 管理者アカウントパスワード
Type : String

(スタンダードイメージのWindows)
 
IpType IPアドレスのタイプ
Type : String
値: static (固定化) | elastic (付替) | none(グローバルIPなし)
Default : static (NetworkInterfaceの定義が指定されていれば、NetworkInterfaceの定義を適用)
   
PublicIp 付替グローバルIPアドレス
Type : String

(IpTypeがelasticの場合)
 
Agreement Red Hat Enterprise Linux 5.8 64bit / 6.3 64bit、またはSPLAサーバーを指定した場合の同意
Type : Boolean
値 : true (同意する) | false (同意しない)
Default : false (同意しない)
   
Description メモ
Type : String
   
NetworkInterface.n.DeviceIndex ※指定不可
Type : xsd:Int
   
NetworkInterface.n.SecurityGroupId.n ※指定不可
Type : xsd:string
   
NetworkInterface.n.NetworkId ネットワークID
Type : xsd:string
値 : net-COMMON_GLOBAL (共通グローバル) | net-COMMON_PRIVATE (共通プライベート) | プライベートLANのネットワークID
○(ネットワーク名といずれか)  
NetworkInterface.n.NetworkName ネットワーク名
Type : xsd:string
○(ネットワークIDといずれか)  
NetworkInterface.n.IpAddress

IPアドレス
Type : xsd:string

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

応答フィールド

フィールド(項目) 説明 サンプル値
RunInstancesResponse RunInstancesレスポンス
Type : RunInstancesResponseType
Ancestor : なし
Children : requestId, reservationId, ownerId, groupSet,
instancesSet, requesterId
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : RunInstancesResponse
Children : なし
dd1c39b0-a251-4596-a058-4f4c35069b9d
reservationId ※返却値なし
Type : xsd:string
Ancestor : RunInstancesResponse
Children : なし
 
ownerId ※返却値なし
Type : xsd:string
Ancestor : RunInstancesResponse
Children : なし
 
groupSet 適用したファイアウォールグループ情報
Type : GroupSetType
Ancestor : RunInstancesResponse
Children : item
 
item ファイアウォールグループ情報
Type : GroupItemType
Ancestor : groupSet
Children : groupId
 
groupId ファイアウォールグループ名
Type : xsd:string
Ancestor : item
Children : なし
 
instancesSet 作成に成功したサーバーの情報セット
Type : RunningInstancesSetType
Ancestor : RunInstancesResponse
Children : item
 
item 作成に成功したサーバーの情報
Type : RunningInstancesItemType
Ancestor : instancesSet
Children : instanceId, instanceUniqueId, imageId, instanceState, privateDnsName, dnsName, reason, keyName, admin, amiLaunchIndex, productCodes, instanceType, launchTime, placement, kernelId, ramdiskId, platform, monitoring, subnetId, vpcId, privateIpAddress, ipAddress, privateIpAddress V6, ipAddress V6, stateReason, architecture, rootDeviceType, rootDeviceName, blockDeviceMapping, instanceLifecycle, spotInstanceRequestId, accountingType, ipType, niftyPrivateIpType, description, networkInterfaceSet
 
instanceId サーバー名
Type : xsd:string
Ancestor : item
Children : なし
server04
instanceUniqueId サーバーユニークID
Type : xsd:string
Ancestor : item
Children : なし
i-efgh1234
imageId OSイメージ名
Type : xsd:string
Ancestor : item
Children : なし
CentOS 5.3 32bit Plain
instanceState サーバーの現在のステータス
Type : InstanceStateType
Ancestor : item
Children : code, name
 
code 現在のステータスコード
Type : xsd:int(A 16-bit unsigned)
値 : 0 (pending) | 16 (running) | 80 (stopped)
Ancestor : instanceState
Children : なし
0
name 現在のステータス名
Type : xsd:string
値 : pending (処理中) | running (起動済み) | stopped (停止済み)
Ancestor : instanceState
Children : なし
pending
privateDnsName プライベートIPアドレス
Type : xsd:string
Ancestor : item
Children : なし
 
dnsName グローバルIPアドレス
Type : xsd:string
Ancestor : item
Children : なし
 
reason 異常時のエラーコード
  • ※instanceStateで異常が発生した場合に返される。instanceStateが正常な場合は、空が返される。
Type : xsd:string
Ancestor : item
Children : なし
 
keyName SSHキー名
Type : xsd:string
Ancestor : item
Children : なし
sshkey01
admin 管理者アカウント
Type : xsd:string
Ancestor : item
Children : なし
 
amiLaunchIndex ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
productCodes ※返却値なし
Type : ProductCodesSetType
Ancestor : item
Children : item
 
item ※返却値なし
Type : ProductCodesSetItemType
Ancestor : productCodes
Children : productCode
 
productCode ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
instanceType サーバータイプ
Type : xsd:string
値 : 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
Ancestor : item
Children : なし
medium
launchTime サーバーの作成日時
表示形式 : yyyy-mm-ddThh:mi:ss.sssZ
Type : xsd:dateTime
Ancestor : item
Children : なし
2010-05-17T11:22:33.456Z
placement ゾーン情報
Type : PlacementResponseType
Ancestor : item
Children : availabilityZone
 
availabilityZone ゾーン情報
Type : xsd:string
Ancestor : placement
Children : なし
east-11
kernelId ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
ramdiskId ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
platform OS情報
Type : xsd:string
値 : windows | redhat | centos | ubuntu
Ancestor : item
Children : なし
centos
monitoring 監視情報
Type : InstanceMonitoringStateType
Ancestor : item
Children : state
 
state 監視ステータス
Type : xsd:string
値 : monitoring-disabled (disabled)
Ancestor : monitoring
Children : なし
monitoring-disabled
subnetId ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
vpcId ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
privateIpAddress プライベートIPアドレス
Type : xsd:string
Ancestor : item
Children : なし
 
ipAddress グローバルIPアドレス
Type : xsd:string
Ancestor : item
Children : なし
 
privateIpAddressV6 プライベートIPアドレス(IPv6)
Type : xsd:string
Ancestor : item
Children : なし
 
ipAddressV6 グローバルIPアドレス(IPv6)
Type : xsd:string
Ancestor : item
Children : なし
 
stateReason ※返却値なし
Type : StateReasonType
Ancestor : item
Children : code, message
 
code ※返却値なし
Type : xsd:string
Ancestor : stateReason
Children : なし
 
message ※返却値なし
Type : xsd:string
Ancestor : stateReason
Children : なし
 
architecture OSイメージのアーキテクチャ
Type : xsd:string
値 : i386 | x86_64
Ancestor : item
Children : なし
i386
rootDeviceType ディスクの種類
Type : xsd:string
値 : disk
Ancestor : item
Children : なし
disk
rootDeviceName ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
blockDeviceMapping 接続しているディスクの情報セット
Type : InstanceBlockDeviceMappingResponseType
Ancestor : item
Children : item
 
item 接続しているディスクの情報
Type : InstanceBlockDeviceMappingResponseItemType
Ancestor : blockDeviceMapping
Children : deviceName, ebs
 
deviceName ディスクの接続デバイス
Type : xsd:string
値 : SCSI(xx:xx)
Ancestor : item
Children : なし
SCSI(0:1)
ebs 接続しているディスクの詳細情報
Type : EbsInstanceBlockDeviceMappingResponseType
Ancestor : item
Children : volumeId, status, attachTime, deleteOnTermination
 
volumeId ディスク名
Type : xsd:string
Ancestor : ebs
Children : なし
 
status 接続ステータス
Type : xsd:string
Ancestor : ebs
Children : なし
 
attachTime ※返却値なし
Type : xsd:dateTime
Ancestor : ebs
Children : なし
 
deleteOnTermination サーバー削除時のディスク消去
Type : xsd:boolean
値 : true (消去) | false (消去しない)
Ancestor : ebs
Children : なし
false
instanceLifecycle ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
spotInstanceRequestId ※返却値なし
Type : xsd:string
Ancestor : item
Children : なし
 
accountingType 利用料金タイプ
Type : xsd:string
値 : 1 (月額課金) | 2 (従量課金)
Ancestor : item
Children : なし
2
ipType グローバルIPアドレスのタイプ
Type : xsd:string
値 : static (固定) | elastic (付替)| none(グローバルIPなし)
Ancestor : item
Children : なし
static
niftyPrivateIpType プライベートIPアドレスのタイプ
Type : xsd:string
値 : static (固定) | elastic (付替)
Ancestor : item
Children : なし
 
description メモ
Type : xsd:string
Ancestor : item
Children : なし
 
networkInterfaceSet ネットワークインターフェース情報セット
Type : NetworkInterfaceSetType
Ancestor : item
Children : item
 
item ネットワークインターフェース情報
Type : InstanceNetworkInterfaceSetItemType
Ancestor : networkInterface
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 : なし
 
groupSet 適用しているファイアウォール情報 ※空を返却
Type : GroupSetType
Ancestor : item
Children : item
 
item ファイアウォール情報 ※空を返却
Type : GroupItemType
Ancestor : groupSet
Children : groupId
 
gruopId ファイアウォールグループ名
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:string
Ancestor : attachment
Children : なし
 
status 接続状態
Type : xsd:string
Ancestor : attachment
Children : なし
 
attachTime ※空を返却
Type : xsd:Calendar
Ancestor : attachment
Children : なし
 
deleteOnTermination サーバー削除時のネットワークインターフェース消去
Type : xsd:string
値 : 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 : なし
 
requesterId セッションID
Type : xsd:string
Ancestor : RunInstancesResponse
Children : なし
 

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=RunInstances&ImageId=1&KeyName=sshkey01
&InstanceType=medium&InstanceId=server04&CommonParams

応答サンプル

<RunInstancesResponse xmlns="https://cp.cloud.nifty.com/api/">
  <requestId>dd1c39b0-a251-4596-a058-4f4c35069b9d</requestId>
  <reservationId />
  <ownerId />
  <groupSet />
  <instancesSet>
    <item>
      <instanceId>server04</instanceId>
      <instanceUniqueId>i-efgh1234</instanceUniqueId>
      <imageId>CentOS 5.3 32bit Plain</imageId>
      <instanceState>
        <code>0</code>
        <name>pending</name>
      </instanceState>
      <privateDnsName />
      <dnsName/>
      <keyName>sshkey01</keyName>
      <instanceType>medium</instanceType>
      <launchTime>2010-05-17T11:22:33.456Z </launchTime>
      <placement>
        <availabilityZone>east-11</availabilityZone>
      </placement>
      <platform>centos</platform>
      <monitoring>
        <state>monitoring-disable</state>
      </monitoring>
      <privateIpAddress />
      <ipAddress />
      <privateIpAddressV6 />
      <ipAddressV6 />
      <architecture>i386</architecture>
      <rootDeviceType>disk</rootDeviceType>
      <blockDeviceMapping>
        <item>
          <deviceName>SCSI (0:1)</deviceName>
          <ebs>
            <volumeId>disk0001</volumeId>
            <status>attaching</status>
            <deleteOnTermination>false</deleteOnTermination>
          </ebs>
        </item>
      </blockDeviceMapping>
      <accountingType>2</accountingType>
      <ipType>static</ipType>
      <niftyPrivateIpType>static</niftyPrivateIpType>
      <networkInterfaceSet>
        <item>
          <networkInterfaceId/>
          <subnetId/>
          <vpcId/>
          <description/>
          <ownerId/>
          <niftyNetworkId>net-COMMON_GLOBAL</niftyNetworkId>
          <niftyNetworkName/>
          <status>in-use</status>
          <macAddress>00-00-00-00-00-00</macAddress>
          <privateDnsName/>
          <sourceDestCheck/>
          <groupSet>
          <groupId/>
          </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>in-use</status>
        <macAddress>00-00-00-00-00-00</macAddress>
        <privateIpAddress/>
        <privateIpAddressV6/>
        <privateDnsName/>
        <sourceDestCheck/>
        <groupSet/>
        <attachment>
          <attachmentID/>
          <deviceIndex>0</deviceIndex>
          <status>attaching</status>
          <attachTime/>
          <deleteOnTermination>true</deleteOnTermination>
        </attachment>
        <association/>
      </item>
      </networkInterfaceSet>
    </item>
  </instancesSet>
</RunInstancesResponse>

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

APIメニュー

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

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