Create Server

サーバを作成します。

APIエンドポイント

リージョン	APIエンドポイント
西日本リージョン3の場合	https://compute.jp-west-3.cloud.global.fujitsu.com
東日本リージョン3の場合	https://compute.jp-east-3.cloud.global.fujitsu.com

HTTPメソッドとURI

POST

/v2.1/{project_id}/servers

HTTPステータスコード

正常時：202

エラー時：400, 401, 403, 404, 409

リクエストパラメータの説明

名前	In	Type	デフォルト値 /必須指定	Description
project_id	path	string	必須	プロジェクトのUUID
server	body	object	必須	サーバのオブジェクト
name	body	string	必須	サーバ名本情報は、コンピュータ名/ホスト名としても使用されます。なお、コンピュータ名/ホスト名に設定する文字列は、以下のように変更され、設定されます。 64文字以上を指定した場合、63文字に短縮空白とアンダースコア(_)を、ハイフン(-)に置換アルファベットの大文字を、小文字に置換ピリオド(.)とハイフン(-)以外の記号を削除先頭がピリオド(.)またはハイフン(-)の場合、文字列を削除末尾がピリオド(.)またはハイフン(-)の場合、文字列を削除 Windowsにおいては、文字列の先頭、末尾以外にピリオド(.)が存在する場合、ピリオド(.)直前までの文字列を採用 Unicode文字U+0000からU+0FFF以外の文字を削除変換によってホスト名が空になった場合、ランダムサーバー名を設定注: サーバ名に以下の文字は使用しないでください。小なり不等号(<) 大なり不等号(>) アンパサンド(&) シングルクォート(') ダブルクォート(") パーセント(%) アットマーク(@)
flavorRef	body	string	必須	フレーバーの種別
security_groups	body	array	任意	セキュリティグループ name属性にセキュリティグループの名前を指定します。名前を省略する場合は、デフォルトのセキュリティグループに作成します。セキュリティグループは設定済のポートに設定されません。
metadata	body	object	任意	メタデータのキーと値のペアメタデータキーと値の最大サイズはそれぞれ、255バイトです。使用OSがWindowsであり、かつパスワードを指定する場合キーに「admin_pass」を指定してください。値に指定するパスワードはcloudbase-initで指定したユーザーに対して設定されます。 cloudbase-initで指定したユーザーについては、イメージ提供元に確認してください。指定例: "metadata": {"admin_pass": "<サーバに設定するパスワード>"} オートフェイルオーバー機能を使用する場合 "fcx.autofailover":"true"を指定してください。なお、以下の条件を1つでも満たすインスタンスは、弊社サポートによる復旧対象外となります。利用者で、インスタンスを再作成または削除してください。 "fcx.autofailover": "false"が設定されているオートスケール対象になっているインスタンスのstatusが、ERRORになっている
accessIPv4	body	string	任意	サーバにアクセスするためのIPv4アドレスサーバには設定されません。
adminPass	body	string	任意	サーバの管理者パスワード省略する場合は、自動的に生成されます。
user_data	body	string	任意	起動時のスクリプトの設定情報 Base64で暗号されている必要があります。
availability_zone	body	string	任意	サーバのアベイラビリティゾーン
networks	body	array	必須	ネットワークのオブジェクトプロジェクトに複数のネットワークが存在する場合は、必須です。ネットワークは一個しかない場合は、省略可能です。
networks.uuid	body	string	任意	サーバに配備するNICのUUID networks.portを省略する場合は、必須です。
networks.port	body	string	任意	既存するNICを配備する場合は、ポートIDを指定します。DOWN状態のサーバを指定する必要があります。networks.uuidを省略する場合は、必須です。セキュリティグループは設定済のポートに設定されません。
networks.fixed_ip	body	string	任意	NICの固定IPアドレス
networks.tag	body	string	任意	ネットワークインターフェースに適用するタグサーバのゲストOSによるメタデータとして参照できます。注: マイクロバージョン2.32以上を指定してください。
block_device_mapping_v2	body	array	任意	ブロックデバイスマッピングの情報例： `"block_device_mapping_v2": [{ "boot_index":"0", "uuid":"ac408821-c95a-448f-9292-73986c790911", "source_type": "image", "volume_size":"25", "destination_type":"volume", "delete_on_termination": true, "tag":"disk1", "disk_bus":"scsi" }]`
block_device_mapping_v2.source_type	body	string	必須	ボリュームのソースタイプ「blank」、「snapshot」、「volume」または「image」を指定します。
block_device_mapping_v2.destination_type	body	string	任意	ボリュームのタイプ「volume」を指定します。
block_device_mapping_v2.delete_on_termination	body	string	false 任意	「true」の場合は、サーバが削除されると、ブートボリュームも削除されます。
block_device_mapping_v2.boot_index	body	integer	None 任意	ハイパーバイザーがサーバをストレージからブートするときの順位 0から始まる整数を指定します。ブートを無効にする場合は、マイナスの値を指定する、もしくは指定しないでください。
block_device_mapping_v2.uuid	body	string	任意	block_device_mapping_v2.source_typeで指定したリソースのUUID
config_drive	body	boolean	任意	コンフィグドライブの有無注: 提供しているOSイメージでは、本パラメータが反映されません。必要に応じてプライベートイメージを作成してください。
key_name	body	string	任意	キーペア名
os:scheduler_hints	body	object	任意	スケジューラに送信するデータ注: リクエストボディ内でトップレベルのキーであり、serverオブジェクトに含めるものではありません。
os:scheduler_hints.group	body	string	任意	サーバグループUUID サーバグループに指定されているポリシーに基づいて、サーバが起動されます。
description	body	string	任意	サーバの説明 255文字までです。注: マイクロバージョン2.19以上を指定してください。
tags	body	array	任意	サーバに付与するタグ以下の条件で指定してください。 60文字以内の文字列。空文字列ではない。「/」で始まらない。コンマが入っていない。 1つのサーバにタグ50個まで。注: マイクロバージョン2.52以上を指定してください。

レスポンスボディ（正常系）の説明

名前	Type	Description
server	object	サーバのオブジェクト
id	string	サーバのUUID
links	array	サーバへのリンクURL
OS-DCF:diskConfig	string	ディスクの設定「AUTO」または「MANUAL」が表示されます。
security_groups	array	セキュリティグループのオブジェクト
adminPass	string	サーバの管理者パスワード enable_instance_passwordが「false」の場合は、表示されません。

リクエスト例

{
  "server": {
    "name": "new-server-test",
    "flavorRef": "f5dc173b-6804-445a-a6d8-c705dad5b5eb",
    "networks": [
      {
        "uuid": "f5dc173b-6804-445a-a6d8-c705dad5b5eb"
      }
    ],
    "block_device_mapping_v2": [
      {
        "boot_index": "0",
        "uuid": "f5dc173b-6804-445a-a6d8-c705dad5b5eb",
        "source_type": "image",
        "volume_size": "40",
        "destination_type": "volume"
      }
    ],
    "key_name": "key_pair",
    "security_groups": [
      {
        "name": "default"
      }
    ]
  },
  "os:scheduler_hints": {
    "group": "f5dc173b-6804-445a-a6d8-c705dad5b5eb"
  }
}

レスポンス例

{
    "server": {
        "OS-DCF:diskConfig": "AUTO",
        "adminPass": "6NpUwoz2QDRN",
        "id": "f5dc173b-6804-445a-a6d8-c705dad5b5eb",
        "links": [
            {
                "href": "http://openstack.example.com/v2/6f70656e737461636b20342065766572/servers/f5dc173b-6804-445a-a6d8-c705dad5b5eb",
                "rel": "self"
            },
            {
                "href": "http://openstack.example.com/6f70656e737461636b20342065766572/servers/f5dc173b-6804-445a-a6d8-c705dad5b5eb",
                "rel": "bookmark"
            }
        ],
        "security_groups": [
            {
                "name": "default"
            }
        ]
    }
}