Create server with scheduler hints
Method | URI | Description |
---|---|---|
POST | /v2/{tenant_id}/servers | スケジューラに直接渡されるスケジューラのヒントを使用してサーバを作成します。 |
Normal response codes: 202
-
「/etc/cloud/cloud.cfg」に以下の設定がない場合は、「/etc/cloud/cloud.cfg.d/datasource.cfg」を作成して追加してください。すでに設定済の場合は、対応する必要はありません。
datasource_list: ['OpenStack']
- イメージを登録(インポート)したユーザーのパスワードを変更すると、イメージを使用できなくなります。その場合は、運用者に以下のどちらかを伝えて、イメージの変更を依頼してください。
- イメージのuuidおよびユーザーの認証情報変更後のイメージのlocation情報
- イメージのuuidおよびユーザーの認証情報変更後に登録(インポート)したイメージのuuid
- インスタンスを作成した際に、"status"が "ERROR"および"fault"の"message"に以下のメッセージが表示された場合、「Create server (1)」に記載する手順でインスタンスを再作成してください。
"Block Device Mapping is Invalid: Volume <ボリュームのuuid> did not finish being
created even after we waited <経過時間(秒)> seconds or <ボリュームのstatus確認回数> attempts."
Request
下表は、スケジューラヒント使用サーバ作成リクエストのURIパラメーターの一覧です。
Name | Type | Description |
---|---|---|
{tenant_id} | String | プロジェクトID |
下表は、スケジューラヒント使用仮想サーバ作成リクエストのボディ部のパラメーターの一覧です。
Name | Type | Description |
---|---|---|
security_group | array
(Optional) |
1つ以上のsecurity_groupオブジェクト。name属性にはセキュリティグループ名を指定してください。本属性を省略した場合、仮想サーバはデフォルトのセキュリティグループに作成されます。
SecurityGroupには、以下のIPアドレスおよびポート番号に対するTCP通信を許可したものを設定してください。 IPアドレス: 169.254.169.254 ポート番号: 80 TCP通信が許可されていないと、インスタンス作成時のホスト名(コンピュータ名)や管理者パスワードの設定が実施されない場合があります。 |
user_data | string
(Optional) |
起動時に使用する構成情報またはスクリプト。Base64でエンコードしている必要があります。
サポートしている形式は、主に下記になります。
業務OSがLinuxの場合、スクリプトのほかにcloud-config形式の指定もできますが、検証未完のため、スクリプトの指定を推奨します。 |
availability_zone | string
(Optional) |
サーバを起動するアベイラビリティゾーン |
server | object | サーバ |
imageRef | string | 仮想サーバに使用するイメージの参照先です。 IDまたはURLを指定してください。 |
flavorRef | string | 仮想サーバに使用するフレーバーの参照先です。 IDまたはURLを指定してください。 |
key_name | string
(Optional) |
指定した名前のキーペアの公開鍵をサーバに割り当てます。 キーペアを割り当てない場合は、key_nameを指定しないでください。key_nameに""(空文字)を指定するとエラーとなります。 |
networks | array
(Optional) |
networksオブジェクト。デフォルトでは、プロジェクトが所属するネットワークすべてが仮想サーバに割り当てられます。必要であれば、1つ以上のNICをサーバに作成することもできます。ネットワークのNICを仮想サーバに割り当てるには、networksオブジェクトのuuid属性にネットワークのUUIDを指定します。
既存ポートのNICを仮想サーバに割り当てるには、networksオブジェクトのポート属性にポートIDを指定します。 サーバ上の複数のNICを指定できます。 ネットワークは必ず指定してください。 仮想サーバに対して、以下の情報を設定するために、仮想サーバを接続するネットワークには仮想ルータが接続されている必要があります。
|
uuid | string
(Optional) |
ネットワークのNICを仮想サーバに割り当てるには、networksオブジェクトのuuid属性にネットワークIDを指定します。port属性を省略した場合は必須です。
ネットワークに複数のサブネットを含む場合、任意のサブネットからIPアドレスが割り当てられます。特定のサブネットのIPアドレスを割当てる場合は、事前にポートを作成し、そのポートのuuidをportで指定してください。 |
port | string
(Optional) |
既存ポートのNICを仮想サーバに割り当てるには、networksオブジェクトのポート属性にポートIDを指定します。uuid属性を省略した場合は必須です。 |
fixed_ip | string
(Optional) |
NICに設定する固定IPv4アドレス。 |
name | string
(Optional) |
仮想サーバ名
本情報は、コンピュータ名/ホスト名としても使用されます。 64文字以上を指定した場合、以下のようになります。
なお、コンピュータ名/ホスト名に設定する文字列は、以下のように変更され、設定されます。
|
metadata | object
(Optional) |
メタデータキーと値のペア。メタデータキーと値の最大サイズはそれぞれ、255バイトです。
|
block_device_mapping_v2 | array | 他のパラメーターが指定された場合にボリュームからサーバを起動できるようにします。 |
device_name | string |
仮想サーバの起動に使用するボリュームのデバイスのパスを記述します。
注: 複数のボリュームを割り当てたインスタンスを作成する場合、デバイス名の
"/dev/vd" + 1文字以上の小文字の半角英字部分 が重複しないようにしてください。警告:
特に理由がない限りは、システムボリュームのデバイス名を デバイス名に指定された文字の優先順序は、 |
source_type | string | ボリュームのボリュームソース種別を記述します。"snapshot"、"volume"、または "image"を選択できます。 |
destination_type | string | 接続先("volume")を指定します。 |
delete_on_termination | bool (Optional) |
インスタンス作成時に作成したボリュームを、インスタンス削除時に削除するかどうかを指定します。
Trueを指定した場合、インスタンス作成時に作成したボリュームを、インスタンス削除時にボリュームも削除します。 Falseを指定した場合、インスタンス作成時に作成したボリュームを、インスタンス削除時にボリュームを削除しません。 未指定時は、False(削除しない)となります。 なお、snapshotが採取されているボリュームは、Trueを指定しても削除されません。 |
boot_index | string | デバイスの起動順序を指定します。0から連続した値を指定します。起動ディスクは、0を指定します。 |
config_drive | String
(Optional) |
falseのみ指定できます。 |
uuid | uuid | source_typeに指定したリソースのUUIDを指定します。 |
volume_size | string | ボリュームサイズをGB単位で指定します。
source_typeにimageを指定した場合は、必ず指定してください。値には、使用するイメージのmin_diskパラメーター以上の値を指定してください。なお、使用するイメージのmin_diskパラメーターが無し、または、0の場合、イメージの提供元に最小サイズを確認し、指定してください。 source_typeにvolumeを指定した場合は、値を指定しても無視されます。 source_typeにsnapshotを指定した場合に、省略すると、スナップショットの採取元のボリュームのサイズとなります。 |
os:scheduler_hints | object | スケジューラに送信するデータ。
"anti-affinity"のserver groupのuuidを指定してインスタンスを作成したとき、インスタンスを作成できるVMホストが無い場合は、インスタンスの作成要求を受け付けた後、インスタンスのstatusがERRORとなります。 専有仮想サーバ機能を使用する場合、"fcx.dedicated": "True"を指定してください。 リクエストボディ内の正しい階層(serverと同じ階層)で記述しなかった場合、無視されます。 |
Example. Create server with scheduler hints: JSON request
{
"server": {
"name": "new-server-test",
"imageRef": "70a599e0-31e7-49b7-b260-868f441e862b",
"flavorRef": "1",
"key_name": "keypair1"
},
"os:scheduler_hints": {
"group": "2b7c42eb-7736-4a0f-afab-f23969a35ada"
}
}
Response
Example. Create server with scheduler hints: JSON response
{
"server": {
"adminPass": "yjzytFHb7XHc",
"id": "f8f4f3ce-f6e0-4e05-8f79-bf984fdfce45",
"links": [
{
"href": "http://openstack.example.com/v2/openstack/servers/f8f4f3ce-f6e0-4e05-8f79-bf984fdfce45",
"rel": "self"
},
{
"href": "http://openstack.example.com/openstack/servers/f8f4f3ce-f6e0-4e05-8f79-bf984fdfce45",
"rel": "bookmark"
}
]
}
}