2.2. DescribeInstances

サーバーの情報を取得します。

2.2.1. リクエストパラメータ

InstanceId.N
 サーバー(インスタンス)のIDです。Nは指定する数だけ1から連番になります。複数指定する場合は InstanceId.1=a******1&InstanceId.2=b******2のように指定します。
IDはコントロールパネルのサーバー詳細画面から確認ください。

  • 必須パラメータ: No(指定しない場合は作成済みの全サーバーの情報を取得します。)

2.2.2. サンプルリクエスト

curl -X GET \
-H 'X-KAGOYA-Auth: 768*******************50f' \
https://kcs-api.kagoya.com/ec2?Action=DescribeInstances \
&InstanceId.1=a******1 \
&InstanceId.2=b******2 \

2.2.3. サンプルレスポンス

<?xml version="1.0" encoding="utf-8"?>
<DescribeInstancesResponse>
  <reservationSet>
    <item>
      <instancesSet>
        <item>
          <blockDeviceMapping>
            <item>
              <status>attached</status>
              <deleteOnTermination>True</deleteOnTermination>
              <volumeId>4*****b</volumeId>
            </item>
          </blockDeviceMapping>
          <monitoring>
            <state>False</state>
          </monitoring>
          <ipAddress>10.12.21.39</ipAddress>
          <instanceId>5*****e</instanceId>
          <hypervisor>kvm</hypervisor>
          <subnetIds>
            <item>None</item>
          </subnetIds>
          <coreCount>1</coreCount>
          <keyName>SampleKeyPair</keyName>
          <imageId>ba7de91</imageId>
          <dnsName>v10-12-21-39.vir.kagoya.net</dnsName>
          <launchTime>2020-03-20T10:53:05Z</launchTime>
          <instanceState>
            <code>16</code>
            <name>running</name>
          </instanceState>
          <rootDeviceName>/dev/sda</rootDeviceName>
          <groupSet>
            <groupName></groupName>
            <groupId>None</groupId>
          </groupSet>
          <instanceName>SampleInstance</instanceName>
          <instanceType>1ef0120</instanceType>
        </item>
      </instanceSet>
    </item>
  </reservationSet>
</DescribeInstancesResponse>