DescribeVirtualMachine

API情報

API種別 Action 対象 名称 実行
設定 DescribeVirtualMachine VM 仮想サーバ情報取得  

リクエストパラメータ

パラメータ 必須 意味
GpServiceCode 対象仮想サーバを含むgpサービスコード
GcServiceCode 対象仮想サーバのgcサービスコード

レスポンス

フィールド タイプ 意味
DescribeVirtualMachineResponse.GcServiceCode String 対象仮想サーバのgcサービスコード
DescribeVirtualMachineResponse.Label String 仮想サーバのラベル
DescribeVirtualMachineResponse.VirtualMachineType String 仮想サーバの品目 (仮想サーバの性能表記)
DescribeVirtualMachineResponse.HostType String 仮想サーバのタイプ (仮想サーバの性能表記)
DescribeVirtualMachineResponse.OS String 仮想サーバのOS (仮想サーバの性能表記)
DescribeVirtualMachineResponse.CPU String 仮想サーバのCPU (仮想サーバの性能表記)
DescribeVirtualMachineResponse.Memory String 仮想サーバのメモリ容量 (仮想サーバの性能表記)
DescribeVirtualMachineResponse.Disk String 仮想サーバのディスクの容量 (仮想サーバの性能表記)
DescribeVirtualMachineResponse.Location String

仮想サーバのロケーション

値: L, R

参考: B-1.2 基本サーバ構成(全プラン共通)ロケーション

DescribeVirtualMachineResponse.Status String 仮想サーバの状態 (仮想サーバの状態遷移)
DescribeVirtualMachineResponse.GlobalAddress Object グローバルアドレス
DescribeVirtualMachineResponse.GlobalAddress.NetworkInterface String グローバルアドレスが割り当てられているインターフェース
DescribeVirtualMachineResponse.GlobalAddress.IPv4Address String IPv4アドレス
DescribeVirtualMachineResponse.GlobalAddress.IPv4DomainName String IPv4アドレス DNS逆引き名
DescribeVirtualMachineResponse.GlobalAddress.IPv6Address String IPv6アドレス
DescribeVirtualMachineResponse.GlobalAddress.IPv6Enabled String

IPv6有効・無効

値: Yes, No

DescribeVirtualMachineResponse.PrivateAddress Object プライベートアドレス
DescribeVirtualMachineResponse.PrivateAddress.NetworkInterface String プライベートアドレスが割り当てられているインターフェース
DescribeVirtualMachineResponse.PrivateAddress.IPv4Address String IPv4アドレス
DescribeVirtualMachineResponse.DiskOptionList Array 追加ディスクオプション (複数)
DescribeVirtualMachineResponse.DiskOptionList.DeviceName String 追加ディスクが接続されているデバイス名
DescribeVirtualMachineResponse.DiskOptionList.Size String ディスク容量 (仮想サーバの性能表記)
DescribeVirtualMachineResponse.GlobalAddressOptionList Array 追加グローバルアドレスオプション (複数)
DescribeVirtualMachineResponse.GlobalAddressOptionList.IPv4 Object 追加グローバルアドレス(IPv4)
DescribeVirtualMachineResponse.GlobalAddressOptionList.IPv4.NetworkInterface String 追加グローバルアドレスが割り当てられているインターフェース
DescribeVirtualMachineResponse.GlobalAddressOptionList.IPv4.IpAddress String IPv4アドレス
DescribeVirtualMachineResponse.GlobalAddressOptionList.IPv4.DomainName String IPv4アドレス DNS逆引き名
DescribeVirtualMachineResponse.GlobalAddressOptionList.IPv6 Object 追加グローバルアドレス(IPv6)
DescribeVirtualMachineResponse.GlobalAddressOptionList.IPv6.NetworkInterface String 追加グローバルアドレスが割り当てられているインターフェース
DescribeVirtualMachineResponse.GlobalAddressOptionList.IPv6.IpAddress String IPv6アドレス
DescribeVirtualMachineResponse.GlobalAddressOptionList.IPv6.Enabled String

IPv6有効・無効

値: Yes, No

DescribeVirtualMachineResponse.MobileWebOption String

モバイルWebオプション有無

値: Yes, No

DescribeVirtualMachineResponse.SecureMailOption String

セキュアメールオプション有無

値: Yes, No

DescribeVirtualMachineResponse.Vlan String VLANオプション (仮想サーバの性能表記)

エラーコード

制限

サンプル

リクエスト

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

レスポンス (JSON)

Json
{
    "DescribeVirtualMachineResponse": {
        "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
        "GcServiceCode": "gc########",
        "Label": "XXXXX",
        "VirtualMachineType": "V10",
        "HostType": "Basic",
        "OS": "CentOS6_64_N",
        "CPU": "1ICU",
        "Memory": "1GB",
        "Disk": "30GB",
        "Location": "L",
        "Status": "Stopped",
        "GlobalAddress": {
            "NetworkInterface": "eth0",
            "IPv4Address": "203.0.113.10",
            "IPv4DomainName": "10.113.0.203.rev.iijgio.jp",
            "IPv6Address": "2001:0db8:0000:0000:0000:0000:0000:0010",
            "IPv6Enabled": "Yes"
        },
        "PrivateAddress": {
            "NetworkInterface": "eth1",
            "IPv4Address": "192.0.2.11"
        },
        "DiskOptionList": [
            {
                "DeviceName": "/dev/xvdb",
                "Size": "100GB"
            },
            {
                "DeviceName": "/dev/xvdc",
                "Size": "300GB"
            }
        ],
        "GlobalAddressOptionList": [
            {
                "IPv4": {
                    "NetworkInterface": "eth0:0",
                    "IpAddress": "203.0.113.11",
                    "DomainName": "11.113.0.203.rev.iijgio.jp"
                },
                "IPv6": {
                    "NetworkInterface": "eth0",
                    "IpAddress": "2001:0db8:0000:0000:0000:0000:000a:0001",
                    "Enabled": "Yes"
                }
            },
            {
                "IPv4": {
                    "NetworkInterface": "eth0:1",
                    "IpAddress": "203.0.113.12",
                    "DomainName": "12.113.0.203.rev.iijgio.jp"
                },
                "IPv6": {
                    "NetworkInterface": "eth0",
                    "IpAddress": "2001:0db8:0000:0000:0000:0000:000a:0002",
                    "Enabled": "No"
                }
            }
        ],
        "MobileWebOption": "No",
        "SecureMailOption": "Yes",
        "Vlan": "Nothing"
    }
}

レスポンス (XML)

XML
<?xml version="1.0" encoding="UTF-8"?>
<DescribeVirtualMachineResponse>
  <RequestId>xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx</RequestId>
  <GcServiceCode>gc########</GcServiceCode>
  <Label>XXXXX</Label>
  <VirtualMachineType>V10</VirtualMachineType>
  <HostType>Basic</HostType>
  <OS>CentOS6_64_N</OS>
  <CPU>1ICU</CPU>
  <Memory>1GB</Memory>
  <Disk>30GB</Disk>
  <Location>L</Location>
  <Status>Stopped</Status>
  <GlobalAddress>
    <NetworkInterface>eth0</NetworkInterface>
    <IPv4Address>203.0.113.10</IPv4Address>
    <IPv4DomainName>10.113.0.203.rev.iijgio.jp</IPv4DomainName>
    <IPv6Address>2001:0db8:0000:0000:0000:0000:0000:0010</IPv6Address>
    <IPv6Enabled>Yes</IPv6Enabled>
  </GlobalAddress>
  <PrivateAddress>
    <NetworkInterface>eth1</NetworkInterface>
    <IPv4Address>192.0.2.11</IPv4Address>
  </PrivateAddress>
  <DiskOptionList>
    <DiskOption>
      <DeviceName>/dev/xvdb</DeviceName>
      <Size>100GB</Size>
    </DiskOption>
    <DiskOption>
      <DeviceName>/dev/xvdc</DeviceName>
      <Size>300GB</Size>
    </DiskOption>
  </DiskOptionList>
  <GlobalAddressOptionList>
    <GlobalAddressOption>
      <IPv4>
        <NetworkInterface>eth0:0</NetworkInterface>
        <IpAddress>203.0.113.11</IpAddress>
        <DomainName>11.113.0.203.rev.iijgio.jp</DomainName>
      </IPv4>
      <IPv6>
        <NetworkInterface>eth0</NetworkInterface>
        <IpAddress>2001:0db8:0000:0000:0000:0000:000a:0001</IpAddress>
        <Enabled>Yes</Enabled>
      </IPv6>
    </GlobalAddressOption>
    <GlobalAddressOption>
      <IPv4>
        <NetworkInterface>eth0:1</NetworkInterface>
        <IpAddress>203.0.113.12</IpAddress>
        <DomainName>12.113.0.203.rev.iijgio.jp</DomainName>
      </IPv4>
      <IPv6>
        <NetworkInterface>eth0</NetworkInterface>
        <IpAddress>2001:0db8:0000:0000:0000:0000:000a:0002</IpAddress>
        <Enabled>No</Enabled>
      </IPv6>
    </GlobalAddressOption>
  </GlobalAddressOptionList>
  <MobileWebOption>No</MobileWebOption>
  <SecureMailOption>Yes</SecureMailOption>
  <Vlan>Nothing</Vlan>
</DescribeVirtualMachineResponse>