API情報
API種別 |
メソッド |
URI |
対象 |
名称 |
実行 |
契約 |
POST |
/:GisServiceCode/virtual-servers.json |
仮想サーバ |
仮想サーバ追加申込 |
同期 |
- 仮想サーバを新規に申し込みます。
- サーバグループを省略すると、自動的にAまたはBのグループにアサインされます
- 通常は指定する必要はありませんが、サーバグループを指定することで収容設備を分けることができるため、複数のサーバを冗長化のために組み合わせて利用したい場合には一方をA、他方をBに指定してください。それにより、障害時の影響範囲をコントロールできるようになります
- 仮想サーバ専有タイプは物理的にサーバを占有する品目であるため、サーバグループを指定することはできません。また、指定しなくても他の仮想サーバとハイパーバイザを共有することはありません。
リクエストパラメータ
|
パラメータ |
必須 |
意味 |
値 |
URL |
GisServiceCode |
○ |
P2契約のサービスコード |
gis######## |
ボディ |
Type |
○ |
仮想サーバ品目
|
|
|
OSType |
○ |
OS種別 |
"Linux", "Windows" |
|
ServerGroup |
|
サーバグループ |
"A", "B"。省略した場合はどちらかが自動的に選択される |
レスポンス
フィールド |
タイプ |
意味 |
値 |
ServiceCode |
String |
仮想サーバのサービスコード |
ivm########, ivd######## |
Label |
String |
ラベル |
文字列 |
ContractStatus |
String |
契約状態
|
|
StartDate |
String |
利用開始日 or 課金開始日 |
YYYYMMDD |
StopDate |
String |
解約予定日 |
YYYYMMDD |
Category |
String |
仮想サーバ種別 |
"BestEffort", "Guarantee", "Dedicated" |
Type |
String |
仮想サーバ品目
|
|
OSType |
String |
OS種別 |
"Linux", "Windows" |
ServerGroup |
String |
サーバグループ |
"A", "B" |
ServiceInfrastructureVersion |
String |
サービス提供基盤のバージョン |
文字列 |
ResourceStatus |
String |
仮想サーバステータス
|
|
ServerSpec.CPU |
String |
コア数 |
例: 1vCore |
ServerSpec.Memory |
String |
メモリ量(GB) |
例: 1GB |
Network.MaxTrafficSpeed |
String |
帯域上限(Mbps) |
例: 100Mbps |
Network.IncludingGlobalSide |
String |
帯域上限にグローバルネットワークを含む品目ならばYes, そうでなければNo |
"Yes", "No" |
StorageList |
Array |
ストレージ一覧 |
オブジェクトの配列。初期状態ではストレージが接続されていないため、常に空配列となります |
NetworkList |
Array |
ネットワーク一覧 |
オブジェクトの配列 |
NetworkList.MacAddress |
String |
MACアドレス |
例: 12-34-56-78-9a-bc |
NetworkList.NetworkType |
String |
ネットワークタイプ |
"Global", "PrivateStandard", "Private"。初期状態では"PrivateStandard"のみが接続されています |
NetworkList.IPv6Enabled |
String |
IPv6有効または無効 |
"Enabled", "Disabled" |
NetworkList.ServiceCode |
String |
プライベートネットワーク/Vのサービスコード |
ivl######## |
NetworkList.URI |
String |
プライベートネットワーク/Vの情報へアクセスするためのURI |
URI |
NetworkList.Label |
String |
ラベル |
文字列 |
NetworkList.IpAddressList |
Array |
IPアドレス一覧 |
オブジェクト配列 |
NetworkList.IpAddressList.IPv4.IpAddress |
String |
IPv4アドレス |
|
NetworkList.IpAddressList.IPv4.Type |
String |
アドレス管理 |
"Managed", "Unmanaged" |
NetworkList.IpAddressList.IPv6.IpAddress |
String |
IPv6アドレス |
|
NetworkList.IpAddressList.IPv6.Type |
String |
アドレス管理 |
"Managed", "Unmanaged" |
エラーコード
- このAPIに関する個別エラーはありません。
- 共通エラーコードはエラーレスポンスを参照して下さい
サンプル
リクエストボディ
{
"Type": "VG1-3",
"OSType": "Linux",
"ServerGroup": "A"
}
レスポンス (JSON)
Json
{
"RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
"ServiceCode": "ivm#######1",
"Label": "",
"ContractStatus": "InService",
"StartDate": "YYYYMMDD",
"StopDate": "",
"Category": "Guarantee",
"Type": "VG1-3",
"OSType": "Linux",
"ServerGroup": "A",
"ResourceStatus": "Stopped",
"ServiceInfrastructureVersion": "",
"ServerSpec": {
"CPU": "1Core",
"Memory": "3GB",
"Network": {
"MaxTrafficSpeed": "100Mbps",
"IncludingGlobalSide": "Yes"
}
},
"StorageList": [],
"NetworkList": [
{
"MacAddress": "12-34-56-78-9a-bc",
"NetworkType": "Global",
"IPv6Enabled": "No",
"IpAddressList": []
},
{
"MacAddress": "12-34-56-78-9a-bc",
"NetworkType": "PrivateStandard",
"IpAddressList": [
{
"IPv4": {
"IpAddress": "192.0.2.1",
"Type": "Managed"
}
}
]
}
]
}