システム内に仮想マシンを作成します。起動ディスクに必要な初期コンテンツとして使用するディスクイメージIDは、必ず指定しなければなりません。リクエストメッセージはUTF-8を用いてエンコードされます。
リクエストパラメーター
パラメーター名 | 項目 | 項目説明 |
---|---|---|
Version | 説明 | CFMG APIのバージョンID |
型 | string ASCII | |
設定内容 | 固定。「1.0」を指定してください。 | |
Locale | 説明 | CFMG APIと通信するための言語。ISO 639で規定されている言語コードを指定します。 |
型 | string ASCII | |
設定内容 | 以下から選択します。 | |
Action | 説明 | 実行するCFMG APIの名称 |
型 | string ASCII | |
設定内容 | 固定。「CreateVServer」を指定してください。 | |
userId | 説明 | CFMG APIを実行するユーザーID |
型 | string ASCII | |
設定内容 | 31文字以内 | |
orgId | 説明 | CFMG APIを実行するユーザーの組織ID |
型 | string ASCII | |
設定内容 | 8文字以内 | |
vsysId | 説明 | システムID |
型 | string ASCII | |
設定内容 | 32文字以内 | |
vserverName | 説明 | 仮想マシン名 |
型 | string UTF-8 | |
設定内容 | 85文字以内。ただし、「<」、「>」、「&」、「‘ 」、「“ 」、および改行は指定できません。 | |
vserverType | 説明 | 仮想マシンタイプ |
型 | string ASCII | |
設定内容 | 32文字以内 | |
diskImageId | 説明 | ディスクイメージID |
型 | string ASCII | |
設定内容 | 32文字以内 | |
controlNetworkId | 説明 | 制御NICを接続するネットワークID |
型 | string ASCII | |
設定内容 | 制御NICのIPアドレスを指定して配備する場合には、以下の形式で指定します。 controlNetworkId=network_id'xxx:xxx:xxx:xxx | |
[networkId] | 説明 | 制御NIC以外のネットワークID |
型 | string ASCII | |
設定内容 | 複数のNICがある場合は、以下の形式で指定します。 networkId=network_1"network_2 また、IPアドレスを指定して配備する場合には、以下の形式で指定します。 networkId=network_1'xxx:xxx:xxx:xxx' 'network_2'xxx:xxx:xxx:xxx | |
[vmPool] | 説明 | VMプールリソース名 |
型 | string ASCII | |
設定内容 | 32文字以内 | |
[storagePool] | 説明 | ストレージプールリソース名 |
型 | string ASCII | |
設定内容 | 32文字以内 | |
[cpuPerf] | 説明 | CPU性能 |
型 | decimal | |
設定内容 | 0.1~99999.9 | |
[numOfCpu] | 説明 | CPU数 |
型 | int | |
設定内容 | 1以上。最大値はイメージごとに指定された値(指定していない場合はINTの最大値)です。 | |
[memorySize] | 説明 | メモリ量 |
型 | decimal | |
設定内容 | 0.1~99999.9 | |
[macAddress] | 説明 | MACアドレスのアドレスセットリソース名。RHEL-Xenの場合に指定可能です。省略時は設定ファイルで指定したデフォルト値が使用されます。 |
型 | string ASCII | |
設定内容 | 32文字以内。ただし、「<」、「>」、「&」、「‘ 」、「“ 」、および改行は指定できません。 |
レスポンス
《ステータスコード》
正常に終了した場合に「200 OK」を返します。
《XML》
<?xml version="1.0" encoding="UTF-8"?> <CreateVServerResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com"> <responseMessage>[メッセージ]</responseMessage> <responseStatus>[ステータス]</responseStatus> <vserverId>[仮想マシンID]</vserverId> </CreateVServerResponse>
《要素》
要素名 | 項目 | 項目説明 |
---|---|---|
CreateVServerResponse | 説明 | レスポンスの情報を持つ要素 |
型 | なし | |
出現回数 | 1 | |
responseMessage | 説明 | メッセージ。リクエストが正しく処理されたかどうかを表します。メッセージの詳細については、「付録A メッセージ」を参照してください。 |
型 | string UTF-8 | |
出現回数 | 1 | |
responseStatus | 説明 | ステータス。リクエストが正常に処理されたかどうかを表します。正常に処理された場合は "SUCCESS" が返却されます。それ以外の場合はエラーコードが返却されます。 |
型 | string ASCII | |
出現回数 | 1 | |
vserverId | 説明 | 仮想マシンID |
型 | string ASCII | |
出現回数 | 0または1 |
サンプルレスポンス
<?xml version="1.0" encoding="UTF-8"?> <CreateVServerResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com"> <responseMessage>PAPI00000 Processing was completed.</responseMessage> <responseStatus>SUCCESS</responseStatus> <vserverId>VSERVER000001</vserverId> </CreateVServerResponse>