GetVirtualMachineStatusList

API情報

API種別 Action 対象 名称 実行
設定 GetVirtualMachineStatusList VM 仮想サーバ状態一覧取得  

リクエストパラメータ

パラメータ 必須 意味
GpServiceCode

対象仮想サーバを含むgpサービスコード

GcServiceCode.# ※1

対象仮想サーバのgcサービスコード

レスポンス

フィールド タイプ 意味

GetVirtualMachineStatusListResponse.GpServiceCode

String 対象仮想サーバを含むgpサービスコード

GetVirtualMachineStatusListResponse.VirtualMachineStatusList

Array 対象仮想サーバ群の状態を示す配列

GetVirtualMachineStatusListResponse.VirtualMachineStatusList.GcServiceCode

String 対象仮想サーバのgcサービスコード

GetVirtualMachineStatusListResponse.VirtualMachineStatusList.Status

String 対象仮想サーバの現在の状態 (仮想サーバの状態遷移)

エラーコード

制限

サンプル

リクエスト

※実際には一行で現します
https://gp.api.iij.jp/json
    ?APIVersion=20130901
    &AccessKeyId=XXXXXXXXXXXXXXXXXXXX
    &Action=GetVirtualMachineStatusList
    &Expire=2013-09-01T10%3A10%3A30Z
    &GcServiceCode.1=gc#######1
    &GcServiceCode.2=gc#######2
    &GpServiceCode=gp########
    &SignatureMethod=HmacSHA256
    &SignatureVersion=2
    &Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

レスポンス (JSON)

Json
{
    "GetVirtualMachineStatusListResponse": {
        "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
        "GpServiceCode": "gp########",
        "VirtualMachineStatusList": [
            {
                "GcServiceCode": "gc#######1",
                "Status": "Running"
            },
            {
                "GcServiceCode": "gc#######2",
                "Status": "Stopped"
            }
        ]
    }
}

レスポンス (XML)

XML
<?xml version="1.0" encoding="UTF-8"?>
<GetVirtualMachineStatusListResponse>
  <RequestId>xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx</RequestId>
  <GpServiceCode>gp########</GpServiceCode>
  <VirtualMachineStatusList>
    <VirtualMachineStatus>
      <GcServiceCode>gc#######1</GcServiceCode>
      <Status>Running</Status>
    </VirtualMachineStatus>
    <VirtualMachineStatus>
      <GcServiceCode>gc#######2</GcServiceCode>
      <Status>Stopped</Status>
    </VirtualMachineStatus>
  </VirtualMachineStatusList>
</GetVirtualMachineStatusListResponse>