仮想サーバ情報取得
API情報
| API種別 | メソッド | URI | 対象 | 名称 | 実行 |
|---|---|---|---|---|---|
| 契約、設定 | GET | /:GisServiceCode/virtual-servers/:IvmServiceCode.json /:GisServiceCode/virtual-servers/:IvdServiceCode.json |
仮想サーバ | 仮想サーバ情報取得 | 同期 |
- 指定した仮想サーバIvmServiceCodeまたはIvdServiceCodeの詳細情報を取得します
- IvmServiceCodeおよびIvdServiceCodeはGisServiceCodeに所属する契約を指定する必要があります
リクエストパラメータ
| パラメータ | 必須 | 意味 | 値 | |
|---|---|---|---|---|
| URL | GisServiceCode | ○ | P2契約のサービスコード | gis######## |
| IvmServiceCode or IvdServiceCode | ○ | サービスコード | 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 | 仮想サーバステータス | |
| RestartRequired | Array | 仮想サーバの再起動が必要な場合に出力 | オブジェクトの配列 |
| RestartRequired.DueDate | String | 再起動実施期限 | YYYYMMDD |
| RestartRequired.Reason | String | 再起動が必要な理由 | 文字列 |
| ServerSpec.CPU | String | コア数 | 例： 1vCore |
| ServerSpec.Memory | String | メモリ量（GB） | 例： 1GB |
| Network.MaxTrafficSpeed | String | 帯域上限（Mbps） | 例： 100Mbps |
| Network.IncludingGlobalSide | String | 帯域上限にグローバルネットワークを含む品目ならばYes, そうでなければNo | "Yes", "No" |
| StorageList | Array | ストレージ一覧 | オブジェクトの配列 |
| StorageList.PciSlot | String | PCIスロット | 16進数。例： 0x10 |
| StorageList.Boot | String | ブート可否 | "Yes", "No" |
| StorageList.ServiceCode | String | ストレージのサービスコード | Iba########, ibg########, ibb########, Ica########, icg########, icb######## |
| StorageList.URI | String | ストレージの情報へアクセスするためのURI | URI |
| StorageList.Type | String | ストレージ品目 | |
| StorageList.OSType | String | OS種別 | "Linux", "Windows", "None" |
| StorageList.Mode | String | ストレージのモード | "Basic", "Backup" |
| StorageList.Encryption | String | 暗号化 | "Yes", "No" |
| NetworkList | Array | ネットワーク一覧 | オブジェクトの配列 |
| NetworkList.MacAddress | String | MACアドレス | 例： 12-34-56-78-9a-bc |
| NetworkList.NetworkType | String | ネットワークタイプ | "Global", "PrivateStandard", "Private" |
| 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" |
制限
- 特になし
サンプル
リクエストボディ
無し
レスポンス (JSON)
{ |
"RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx", |
"Label": "XXXXX", |
"ContractStatus": "InService", |
"StartDate": "YYYYMMDD", |
"StopDate": "", |
"Category": "Guarantee", |
"Type": "VG1-3", |
"OSType": "Linux", |
"ServerGroup": "A", |
"ResourceStatus": "Stopped", |
"ServiceInfrastructureVersion": "##.##.##", |
"RestartRequired": { |
"DueDate": "YYYYMMDD", |
"Reason": "Virtual server is required to move to new infrastructure due to infrastructure EOL" |
}, |
"ServerSpec": { |
"CPU": "1Core", |
"Memory": "3GB", |
"Network": { |
"MaxTrafficSpeed": "100Mbps", |
"IncludingGlobalSide": "Yes" |
} |
}, |
"StorageList": [ |
{ |
"PciSlot": "0x10", |
"Boot": "Yes", |
"ServiceCode": "iba########", |
"URI": "", |
"Type": "S30GB_CentOS7_64", |
"OSType": "Linux", |
"Mode": "Basic", |
"Encryption": "No" |
}, |
{ |
"PciSlot": "0x11", |
"Boot": "No", |
"Category": "Guarantee", |
"ServiceCode": "ibg#######1", |
"URI": "", |
"Type": "G100GB_IOPS1000", |
"OSType": "None", |
"Mode": "Basic", |
"Encryption": "No" |
}, |
{ |
"PciSlot": "0x12", |
"Boot": "No", |
"Category": "BestEffort", |
"ServiceCode": "ibb#######1", |
"URI": "", |
"Type": "B500GB", |
"OSType": "None", |
"Mode": "Basic", |
"Encryption": "No" |
} |
], |
"NetworkList": [ |
{ |
"MacAddress": "12-34-56-78-9a-bc", |
"NetworkType": "Global", |
"IPv6Enabled": "No", |
"IpAddressList": [ |
{ |
"IPv4": { |
"IpAddress": "203.0.113.11", |
"Type": "Managed", |
"DomainName": "11.113.0.203.rev.iijgio.jp" |
}, |
"IPv6": { |
"IpAddress": "2001:0db8:0000:0000:0000:0000:0000:000b", |
"Type": "Unmanaged" |
} |
}, |
{ |
"IPv4": { |
"IpAddress": "203.0.113.12", |
"Type": "Unmanaged", |
"DomainName": "12.113.0.203.rev.iijgio.jp" |
}, |
"IPv6": { |
"IpAddress": "2001:0db8:0000:0000:0000:0000:0000:000c", |
"Type": "Unmanaged" |
} |
} |
] |
}, |
{ |
"MacAddress": "12-34-56-78-9a-bd", |
"NetworkType": "PrivateStandard", |
"IpAddressList": [ |
{ |
"IPv4": { |
"IpAddress": "192.0.2.1", |
"Type": "Managed" |
} |
} |
] |
}, |
{ |
"MacAddress": "12-34-56-78-9a-be", |
"NetworkType": "Private", |
"ServiceCode": "ivl#######1", |
"URI": "", |
"Label": "XXXXX" |
}, |
{ |
"MacAddress": "12-34-56-78-9a-bf", |
"NetworkType": "Private", |
"ServiceCode": "ivl#######2", |
"URI": "", |
"Label": "XXXXX" |
} |
] |
} |