仮想サーバ情報一覧取得

API情報

API種別	メソッド	URI	対象	名称	実行
契約、設定	GET	/:GisServiceCode/virtual-servers.json?StartIndex=N&Count=M	仮想サーバ	仮想サーバ情報一覧取得	同期

指定したGisServiceCodeに所属する仮想サーバの詳細情報一覧を取得します

リクエストパラメータ

	パラメータ	必須	意味	値
URL	GisServiceCode	○	P2契約サービスコード	文字列
クエリストリング	StartIndex		StartIndexだけスキップした位置から情報を取得する	数値
	Count		取得する情報の最大数	数値

レスポンス

フィールド	タイプ	意味	値
VirtualServerList	Array	仮想サーバ情報	オブジェクトの配列
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	仮想サーバステータス
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"

エラーコード

このAPIに関する個別エラーはありません。
共通エラーコードはエラーレスポンスを参照して下さい

制限

特になし

サンプル

リクエストボディ

無し

レスポンス (JSON)

Json

{
    "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
    "VirtualServerList": [
        {
            "Category": "Guarantee",
            "ServiceCode": "ivm#######1",
            （略）仮想サーバ情報取得と同じ
        },
        {
            "Category": "BestEffort",
            "ServiceCode": "ivm#######2",
            （略）仮想サーバ情報取得と同じ
        },
        {
            "Category": "Dedicated",
            "ServiceCode": "ivd#######1",
            （略）仮想サーバ情報取得と同じ
        }
    ]
}