GMOクラウド Public APIリファレンス

サポートトップ » GMOクラウド Public トップ » APIリファレンス

deployNode

機能の処理概要

仮想サーバーの作成

仮想サーバーを構築します。
仮想サーバーの構築完了後、仮想サーバーを起動します。

リクエストパラメーター

この機能の実行時には以下のパラメーターを指定してください。

パラメーター 説明 必須
template_id テンプレートID

仮想サーバーの構築時に使用するテンプレートのIDを指定します
システムテンプレートとユーザーテンプレートのIDは、11.1 listImages APIで取得できます
11.1 listImagesのレスポンスオブジェクトのうち、id が該当します
Identifier テンプレートID

(上述の template_id と同意で、一定の期間経過後にこのパラメーターは廃止します)
仮想サーバーの構築時に使用するテンプレートのIDを指定します
システムテンプレートとユーザーテンプレートのIDは、11.1 listImages APIで取得できます
11.1 listImagesのレスポンスオブジェクトのうち、id が該当します
×
cpu_shares CPU占有率

構築する仮想サーバーのハイパーバイザーにXenを選択する場合、仮想CPUの占有率を任意の数値で指定できます
このパラメーターを指定しない場合の初期値は1です
ハイパーバイザーにKVMを選択した場合は100で固定されます
×
cpus CPUコア数

構築する仮想サーバーに割り当てる仮想CPUコア数を指定します
data_store_group_primary_id ディスク データストアID

構築する仮想サーバーに割り当てるプライマリディスクのデータストアゾーンのIDを指定します
データストアゾーンのIDは、12.1. listDatastores API で取得できます
12.1 listDatastores APIのレスポンスオブジェクトのうち、idが該当します
×
data_store_group_swap_id スワップ データストアID

構築する仮想サーバーに割り当てるスワップディスクのデータストアゾーンのIDを指定します
データストアゾーンのIDは、12.1. listDatastores APIで取得できます
12.1 listDatastores APIのレスポンスオブジェクトのうち、idが該当します
×
hostname ホスト名

構築する仮想サーバーの hostname を指定します
hypervisor_group_id ハイパーバイザーグループID

仮想サーバーを構築するハイパーバイザーに割り当てられたハイパーバイザーグループIDを指定します
ハイパーバイザーグループIDを指定しない場合は、GMOクラウドPublic の中で利用できるいずれかのハイパーバイザーに仮想サーバーが構築されます
ハイパーバイザーグループIDは、3.1 listHypervisors APIで取得できます
3.1 listHypervisors API のレスポンスオブジェクトのうち、hypervisor_group_id が該当します
×
hypervisor_id ハイパーバイザーID

仮想サーバーを構築するハイパーバイザーのIDを指定します
ハイパーバイザーIDを指定しない場合は、GMOクラウドPublicの全てのハイパーバイザーのうち、最もメモリ容量の残りがあるハイパーバイザーの中に構築されます
ハイパーバイザーIDは、3.1 listHypervisors APIで取得できます
3.1 listHypervisors APIのレスポンスオブジェクトのうち、id が該当します
×
initial_root_password rootパスワード

構築する仮想サーバーのrootユーザーの初期パスワードを指定します
パスワードは以下の文字列を使用することができます
・ 6文字以上32文字以内
・ AからZまでの半角英大文字
・ aからzまでの半角英小文字
・ 0から9までの半角数字
・ -(ハイフン)、_(アンダースコア)

初期パスワードの文字列を何も指定しない場合、GMOクラウドPublicのシステムがランダムな文字列で生成したパスワードを設定します
×
label ラベル

構築する仮想サーバーのラベルを指定します
仮想サーバーを複数構築する場合など、判別しやすくするためのものです
memory メモリ[MB]

構築する仮想サーバーに割り当てるメモリ容量を指定します
単位はMB (MegaBytes)です
note メモ

構築する仮想サーバーに付加できるコメントを指定します
×
primary_disk_size ディスクサイズ[GB]

構築する仮想サーバーのプライマリディスクのディスクサイズ(ディスク容量)を指定します

単位はGB (GigaBytes)です
primary_network_group_id ネットワークグループID

構築する仮想サーバーに割り当てるネットワークグループのIDを指定します
ネットワークグループIDは、8.1. listNetworks API で取得できます
8.1. listNetworks API のレスポンスオブジェクトのうち、network_group_id が該当します
×
primary_network_id ネットワークID

構築する仮想サーバーに割り当てるネットワークのIDを指定します
ネットワークIDは、8.1. listNetworks API で取得できます
8.1. listNetworks APIのレスポンスオブジェクトのうち、idが該当します
×
rate_limit 帯域[Mbps]

構築する仮想サーバーに割り当てるネットワークのポートスピードを指定します
単位は Mbps です
required_automatic_backup 自動バックアップ指定

構築する仮想サーバーで自動バックアップを行う指定をします

1 : 自動バックアップを行う設定
0 : 自動バックアップを行わない設定
×
required_virtual_machine_build サーバー構築

構築する仮想サーバーで構築して起動させるかを指定をします

1 : 構築して起動する
0 : 仮想サーバーの確保のみ行う
×
selected_ip_address_id IPアドレス

構築する仮想サーバーに割り当てるIPアドレスを指定します
指定できるIPアドレスは 9.1. listIpAddresses APIで取得できます
9.1 listIpAddresses APIのレスポンスオブジェクトのうち、free パラメーターが true の IPアドレスの id が該当します
×
swap_disk_size スワップディスク容量

構築する仮想サーバーに割り当てるスワップディスクのディスクサイズ(ディスク容量)を指定します
単位は GB (GigaBytes)です
Windows系OSの場合にはスワップディスクはありません

レスポンスオブジェクト

以下の形式で応答します

フィールド 説明
Identifier 仮想サーバーの構築のリクエストに成功した場合、仮想サーバーに割り当てられるIdentifierを返します

リクエストサンプル

https://api.gmocloud.com/Cloud-Zone-ID/?Action=deployNode&AccessKeyId=AccessKeyId&Version=1.0&template_id=ID_of_Template&cpu_shares=1&cpus=1 &data_store_group_primary_id=ID_of_DataStore-Group&data_store_group_swap_id=ID_of_DataStore-Group&hostname=gmocloud.example.com&hypervisor_group_id=ID_of_HV-Group&hypervisor_id=ID_of_HV&initial_root_password=Password&label=VM-Label-example&memory=128¬e=memo&primary_disk_size=5&primary_network_group_id=ID_of_Network-Group&primary_network_id=ID_of_Network&rate_limit=1&required_automatic_backup=0&required_virtual_machine_build=0 &selected_ip_address_id=ID_of_IPaddress&swap_disk_size=1&Signature=Signature

レスポンスサンプル

{
  "identifier": "Identifier_of_VM"
}

このガイドで問題は解決しましたか?

ご回答ありがとうございました。

引き続きGMOクラウド サポートサイトをご利用ください。

ご回答ありがとうございました。

GMOクラウド Public サポートまでお問い合わせください。

お問い合わせ