2.4. RunInstances¶

サーバー(インスタンス)を作成します。

2.4.1. リクエストパラメータ¶

InstanceName
　サーバー(インスタンス)の名称です。30文字以内で任意に指定できます。

必須パラメータ: Yes

KeyName
　ログイン用認証キーの名称です。コントロールパネル内のログイン用認証キー画面から確認できます。

※利用したいキーをコントロールパネルから削除した場合、またはキー作成時にダウンロードされた keyファイルを紛失した場合はそのキーを利用できません。新たにキーを再作成する必要があります。
※ISOのImageId以外を指定した場合は必須です。

必須パラメータ: No

ImageId
　OSのパッケージ(イメージ)IDです。DescribeImagesから取得される情報から利用したいImageIdを指定ください。

必須パラメータ: Yes

InstanceType
　スペックIDです。選択できるスペックIDはスペック一覧表のスペック一覧表を参照ください。

必須パラメータ: Yes

BlockDeviceMapping.VolumeSize
　サーバー作成時に合わせて作成、装着されるディスクのサイズを指定します。
　指定できるサイズはディスク容量一覧のディスクサイズを参照ください。

必須パラメータ: Yes

SubnetId
　スイッチのIDです。値はコントロールパネルのスイッチ詳細画面から確認ください。作成したサーバーに組み込むローカルネットワークになります。指定した場合はサーバーにグローバルIPは発行されません。 指定しない場合はどのローカルネットワークにも組み込まれずサーバーにグローバルIPが発行されます。

必須パラメータ: No

SecurityGroupId
　セキュリティグループのIDです。値はコントロールパネルのセキュリティグループ一覧画面から確認ください。

※SubnetIdを指定した場合、この値は無視されます。

必須パラメータ: No

UserData
　サーバー作成直後に実行されるシェルスクリプトを指定します。

※ISOのImageIdを指定した場合はこの値は無視されます。

必須パラメータ: No

2.4.2. サンプルリクエスト¶

以下の場合サーバーにグローバルIPが発行され、20GBのディスクが装着され、CPUとメモリが1コア/1GBであるサーバーが作成されます。

curl -X GET \
-H 'X-KAGOYA-Auth: 768*******************50f' \
https://api.cloudtap.jp/ec2?Action=RunInstances \
&InstanceName=SampleInstance \
&KeyName=SampleKeyPair \
&ImageId=b*****1 \
&InstanceType=1ef0120 \
&BlockDeviceMapping.VolumeSize=20

以下の場合サーバーにグローバルIPは発行されず、1**a**6のスイッチに装着される。80GBのディスクが装着され、CPUとメモリが2コア/4GBであるサーバーが作成されます。

curl -X GET \
-H 'X-KAGOYA-Auth: 768*******************50f' \
https://api.cloudtap.jp/ec2?Action=RunInstances \
&InstanceName=SampleInstance \
&KeyName=SampleKeyPair \
&ImageId=b*****1 \
&InstanceType=1ef0200 \
&SubnetId=1**a**6 \
&BlockDeviceMapping.VolumeSize=80

2.4.3. サンプルレスポンス¶

サーバー名はinstanceNameから取得できます。サーバーのコンソールパスワードはランダムに設定され、rootPasswordから値が取得できます。

<?xml version="1.0" encoding="utf-8"?>
<RunInstancesResponse>
    <instancesSet>
        <item>
            <blockDeviceMapping>
                <item>
                    <status>attached</status>
                    <delete_on_termination>True</delete_on_termination>
                    <volumeId>c*****3</volumeId>
                </item>
            </blockDeviceMapping>
            <monitoring>
                <state>False</state>
            </monitoring>
            <ipAddress>10.12.21.39</ipAddress
            ><cpuOptions>
                <coreCount>1</coreCount>
            </cpuOptions>
            <instanceId>c*****4</instanceId>
            <hypervisor>kvm</hypervisor>
            <subnetIds>
                <item>None</item>
            </subnetIds>
            <rootPassword>******</rootPassword>
            <keyName>SampleKeyPair</keyName>
            <imageId>ba7de91</imageId>
            <platform></platform>
            <dnsName>v10-12-21-39.vir.kagoya.net</dnsName>
            <launchTime>2020-03-30T10:53:05Z</launchTime>
            <architecture>x86_64</architecture>
            <instanceState>
                <code>16</code>
                <name>running</name>
            </instanceState>
            <rootDeviceName>/dev/sda</rootDeviceName>
            <groupSet>
                <groupName></groupName>
                <groupId>None</groupId>
            </groupSet>
            <instanceName>SampleInstance</instanceName>
            <instanceType>1ef0120</instanceType>
        </item>
    </instancesSet>
</RunInstancesResponse>