Description

VPSを作成します。

VPSを作成するには、予めブートストレージ用のボリュームが作成されている必要があります。

VPSの作成時にセキュリティグループを指定しない場合は、「default」のセキュリティグループが設定されます。セキュリティグループを指定する場合は、「ID指定」と「NAME指定」の2種類の形式があります。使用する形式に合わせて「security_groups」に必要な情報を指定してください。
リモートデスクトップSALが必要なWindows Serverは、APIから作成することができません。コントロールパネルから作成ください。
Windows Serverでは、「user-data」を指定することはできません。
「user-data」で指定するスタートアップスクリプトのサイズは、エンコードされていない状態で「16 KiB」まで指定可能です。
スタートアップスクリプトで指定できるヘッダーは以下となります。
・’#!’
・’#include-once’
・’#include’
・’#cloud-config’
・’#cloud-boothook’

Request URL

Compute API

POST /v2.1/servers

Request Json

・パスワード認証およびセキュリティグループ指定なし

{
  "server": {
    "flavorRef": "フレーバーID",
    "adminPass": "管理者パスワード",
    "block_device_mapping_v2": [
      {
        "uuid": "ボリュームID"
      }
    ],
    "metadata": {
      "instance_name_tag": "サーバー名"
    }
  }
}

・パスワード認証およびセキュリティグループの「NAME 指定」あり

{
  "server": {
    "flavorRef": "フレーバーID",
    "adminPass": "管理者パスワード",
    "block_device_mapping_v2": [
      {
        "uuid": "ボリュームID"
      }
    ],
    "metadata": {
      "instance_name_tag": "サーバー名"
    },
    "security_groups": [
      {
        "name": "セキュリティグループ名"
      }
    ]
  }
}

・パスワード認証およびセキュリティグループの「ID 指定」あり

{
  "server": {
    "flavorRef": "フレーバーID",
    "adminPass": "管理者パスワード",
    "block_device_mapping_v2": [
      {
        "uuid": "ボリュームID"
      }
    ],
    "metadata": {
      "instance_name_tag": "サーバー名"
    },
    "security_groups": [
      "セキュリティグループID"
    ]
  }
}

・鍵認証およびセキュリティグループ指定なし

{
  "server": {
    "flavorRef": "フレーバーID",
    "adminPass": "管理者パスワード",
    "block_device_mapping_v2": [
      {
        "uuid": "ボリュームID"
      }
    ],
    "metadata": {
      "instance_name_tag": "サーバー名"
    },
    "key_name": "SSH Key名"
  }
}

・鍵認証およびセキュリティグループの「NAME 指定」あり

{
  "server": {
    "flavorRef": "フレーバーID",
    "adminPass": "管理者パスワード",
    "block_device_mapping_v2": [
      {
        "uuid": "ボリュームID"
      }
    ],
    "metadata": {
      "instance_name_tag": "サーバー名"
    },
    "security_groups": [
      {
        "name": "セキュリティグループ名"
      }
    ],
    "key_name": "SSH Key名"
  }
}

・鍵認証およびセキュリティグループの「ID 指定」あり

{
  "server": {
    "flavorRef": "フレーバーID",
    "adminPass": "管理者パスワード",
    "block_device_mapping_v2": [
      {
        "uuid": "ボリュームID"
      }
    ],
    "metadata": {
      "instance_name_tag": "サーバー名"
    },
    "security_groups": [
      "セキュリティグループID"
    ],
    "key_name": "SSH Key名"
  }
}

・全パラメータ指定の場合

{
  "server": {
    "flavorRef": "フレーバーID",
    "adminPass": "管理者パスワード",
    "block_device_mapping_v2": [
      {
        "uuid": "ボリュームID"
      }
    ],
    "metadata": {
      "instance_name_tag": "サーバー名"
    },
    "security_groups": [
      {
        "name": "セキュリティグループ名"
      }
    ],
    "key_name": "SSH Key名",
    "user_data": "base64エンコード値"
  }
}

Request Parameters

Parameter Value Style Description
X-Auth-Token トークン header トークンの情報を指定します。
トークンの発行方法は、トークン発行 にてご確認ください。
flavorRef フレーバーID body フレーバーIDを指定します。
フレーバーIDの確認方法は、サーバープラン一覧取得 を実行の上、レスポンス結果から対象プランのフレーバーIDをご確認ください。
adminPass 管理者パスワード body サーバーの管理者パスワードを指定します。
uuid ボリュームID body ブートストレージのボリュームIDを指定します。

ボリュームが未作成の場合は、ボリューム作成 をご参考に作成の上、レスポンス結果から対象ボリュームのボリュームIDをご確認ください。

ボリュームを作成済みの場合は、ボリューム一覧取得 を実行の上、レスポンス結果から対象ボリュームのボリュームIDをご確認ください。
instance_name_tag サーバー名 body 任意のサーバーの名前を指定します。
コントロールパネルのネームタグに反映されます。
name
(Optional)
セキュリティグループ名 body セキュリティグループ名を指定します。
セキュリティグループ名の確認方法は、セキュリティグループ一覧取得 を実行の上、レスポンス結果から対象セキュリティグループの「name」をご確認ください。
key_name
(Optional)
SSH Key名 body SSH Key名を指定します。
SSH Key名の確認方法は、SSHキーペア一覧取得 を実行の上、レスポンス結果から対象SSH Keyの「name」をご確認ください。
user_data
(Optional)
base64エンコード値 body base64でエンコードされたスタートアップスクリプトの値を指定します。

Response Code

Success

202

Example

Request

curl -X POST \
-H "Accept: application/json" \
-H "X-Auth-Token: トークン" \
-d '{"server": {"flavorRef": "フレーバーID","adminPass": "管理者パスワード","block_device_mapping_v2": [{"uuid": "ボリュームID"}],"metadata": {"instance_name_tag": "サーバー名"},"security_groups": [{"name": "セキュリティグループ名"}]}}' \
https://compute.c3j1.conoha.io/v2.1/servers

Response

{
	"server": {
		"id": "サーバーID",
		"links": [
			{
				"rel": "self",
				"href": "https://compute.c3j1.conoha.io/v2.1/servers/ec8fbc40-658f-453d-b817-e66a6cf530f2"
			},
			{
				"rel": "bookmark",
				"href": "https://compute.c3j1.conoha.io/servers/ec8fbc40-658f-453d-b817-e66a6cf530f2"
			}
		],
		"OS-DCF:diskConfig": "MANUAL",
		"security_groups": [],
		"adminPass": "管理者パスワード"
	}
}

ConoHaにて提供しておりますAPIにつきましては、クラウド基盤として採用しておりますOpenStackの機能にて実装しておりますので、詳細な情報や使い方はOpenStackのドキュメントにてご確認ください。