DescribeLb

API情報

API種別 Action 対象 名称 実行
設定 DescribeLb FW/LB LB情報取得  

リクエストパラメータ

パラメータ 必須 意味
GpServiceCode 対象FW+LBオプションを含むgpサービスコード
GlServiceCode 対象FW+LBオプションのglサービスコード

レスポンス

フィールド タイプ 意味
DescribeLbResponse.GlServiceCode String 対象FW+LBオプションのglサービスコード
DescribeLbResponse.Label String 対象FW+LBオプションのラベル
DescribeLbResponse.Type String 対象FW+LBオプションの品目 (ロードバランサの性能表記)
DescribeLbResponse.Redundant String

対象FW+LBオプションが冗長構成かどうか

値: Yes, No

DescribeLbResponse.TrafficIpList Array LBグローバルアドレスのリスト
DescribeLbResponse.TrafficIpList.Primary String

FW+LBオプションに初期状態で割立てられたLBグローバルアドレスかどうか

値: Yes, No

DescribeLbResponse.TrafficIpList.IPv4.TrafficIpName String LBグローバルアドレスの名称
DescribeLbResponse.TrafficIpList.IPv4.TrafficIpAddress String LBグローバルアドレスのIPv4アドレス
DescribeLbResponse.TrafficIpList.IPv4.DomainName String LBグローバルアドレスのDNS逆引き名
DescribeLbResponse.TrafficIpList.IPv6.TrafficIpName String LBグローバルアドレスの名称
DescribeLbResponse.TrafficIpList.IPv6.TrafficIpAddress String LBグローバルアドレスのIPv6アドレス
DescribeLbResponse.TrafficIpList.IPv6.DomainName String LBグローバルアドレスのDNS逆引き名
DescribeLbResponse.VirtualServerList Array LB仮想サービスのリスト
DescribeLbResponse.VirtualServerList.Name String LB仮想サービスの名称
DescribeLbResponse.VirtualServerList.Port String LB仮想サービスのポート
DescribeLbResponse.VirtualServerList.Protocol String

LB仮想サービスのプロトコル

(ロードバランサで使用するプロトコルの表記)

DescribeLbResponse.VirtualServerList.Pool String LB仮想サービスが利用するプール
DescribeLbResponse.VirtualServerList.Enabled String

LB仮想サービスの状態 (有効, 無効)

値: Yes, No

DescribeLbResponse.VirtualServerList.TrafficIpNameList Array LB仮想サービスが利用するLBグローバルアドレスのリスト
DescribeLbResponse.PoolList Array プールのリスト
DescribeLbResponse.PoolList.Name String プール名称
DescribeLbResponse.PoolList.NodeList Array プールに含まれるノードのリスト
DescribeLbResponse.PoolList.NodeList.IpAddress String ノードのIPアドレス
DescribeLbResponse.PoolList.NodeList.Port String ノードのポート
DescribeLbResponse.PoolList.NodeList.Status String

ノードの状態 (有効・ドレイン・無効)

値: Active, Draining, Disable

エラーコード

制限

サンプル

リクエスト

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

レスポンス (JSON)

Json
{
    "DescribeLbResponse": {
        "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
        "GlServiceCode": "gl########",
        "Label": "XXXXX",
        "Type": "B100M",
        "Redundant": "Yes",
        "TrafficIpList": [
            {
                "Primary": "Yes",
                "IPv4": {
                    "TrafficIpName": "GIO_TRAFFIC_IP",
                    "TrafficIpAddress": "203.0.113.20",
                    "DomainName": "20.113.0.203.rev.iijgio.jp"
                },
                "IPv6": {
                    "TrafficIpName": "GIO_TRAFFIC_IP6",
                    "TrafficIpAddress": "2001:0db8:0000:0000:0000:0000:000b:0001",
                    "DomainName": ""
                }
            },
            {
                "Primary": "No",
                "IPv4": {
                    "TrafficIpName": "name1",
                    "TrafficIpAddress": "203.0.113.21",
                    "DomainName": "21.113.0.203.rev.iijgio.jp"
                },
                "IPv6": {
                    "TrafficIpName": "name1_v6",
                    "TrafficIpAddress": "2001:0db8:0000:0000:0000:0000:000b:0002",
                    "DomainName": ""
                }
            }
        ],
        "VirtualServerList": [
            {
                "Name": "GIO_WEB_SERVICE",
                "Port": "22",
                "Protocol": "http",
                "Pool": "GIO_WEB_POOL",
                "Enabled": "Yes",
                "TrafficIpNameList": [
                    "GIO_TRAFFIC_IP",
                    "GIO_TRAFFIC_IP6"
                ]
            },
            {
                "Name": "GIO_WEB_SERVICE2",
                "Port": "80",
                "Protocol": "http",
                "Pool": "GIO_WEB_POOL",
                "Enabled": "Yes",
                "TrafficIpNameList": [
                    "GIO_TRAFFIC_IP"
                ]
            }
        ],
        "PoolList": [
            {
                "Name": "GIO_WEB_POOL",
                "NodeList": [
                    {
                        "IpAddress": "192.0.2.20",
                        "Port": "80",
                        "Status": "Active"
                    },
                    {
                        "IpAddress": "192.0.2.21",
                        "Port": "80",
                        "Status": "Active"
                    }
                ]
            },
            {
                "Name": "GIO_WEB_POOL2",
                "NodeList": [
                    {
                        "IpAddress": "192.0.2.22",
                        "Port": "80",
                        "Status": "Active"
                    }
                ]
            }
        ]
    }
}

レスポンス (XML)

XML
<?xml version="1.0" encoding="UTF-8"?>
<DescribeLbResponse>
  <RequestId>xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx</RequestId>
  <GlServiceCode>gl########</GlServiceCode>
  <Label>XXXXX</Label>
  <Type>B100M</Type>
  <Redundant>Yes</Redundant>
  <TrafficIpList>
    <TrafficIp>
      <Primary>Yes</Primary>
      <IPv4>
        <TrafficIpName>GIO_TRAFFIC_IP</TrafficIpName>
        <TrafficIpAddress>203.0.113.20</TrafficIpAddress>
        <DomainName>20.113.0.203.rev.iijgio.jp</DomainName>
      </IPv4>
      <IPv6>
        <TrafficIpName>GIO_TRAFFIC_IP6</TrafficIpName>
        <TrafficIpAddress>2001:0db8:0000:0000:0000:0000:000b:0001</TrafficIpAddress>
        <DomainName></DomainName>
      </IPv6>
    </TrafficIp>
    <TrafficIp>
      <Primary>No</Primary>
      <IPv4>
        <TrafficIpName>name1</TrafficIpName>
        <TrafficIpAddress>203.0.113.21</TrafficIpAddress>
        <DomainName>21.113.0.203.rev.iijgio.jp</DomainName>
      </IPv4>
      <IPv6>
        <TrafficIpName>name1_v6</TrafficIpName>
        <TrafficIpAddress>2001:0db8:0000:0000:0000:0000:000b:0002</TrafficIpAddress>
        <DomainName></DomainName>
      </IPv6>
    </TrafficIp>
  </TrafficIpList>
  <VirtualServerList>
    <VirtualServer>
      <Name>GIO_WEB_SERVICE</Name>
      <Port>22</Port>
      <Protocol>http</Protocol>
      <Pool>GIO_WEB_POOL</Pool>
      <Enabled>Yes</Enabled>
      <TrafficIpNameList>
        <TrafficIpName>GIO_TRAFFIC_IP</TrafficIpName>
        <TrafficIpName>GIO_TRAFFIC_IP6</TrafficIpName>
      </TrafficIpNameList>
    </VirtualServer>
    <VirtualServer>
      <Name>GIO_WEB_SERVICE2</Name>
      <Port>80</Port>
      <Protocol>http</Protocol>
      <Pool>GIO_WEB_POOL</Pool>
      <Enabled>Yes</Enabled>
      <TrafficIpNameList>
        <TrafficIpName>GIO_TRAFFIC_IP</TrafficIpName>
      </TrafficIpNameList>
    </VirtualServer>
  </VirtualServerList>
  <PoolList>
    <Pool>
      <Name>GIO_WEB_POOL</Name>
      <NodeList>
        <Node>
          <IpAddress>192.0.2.20</IpAddress>
          <Port>80</Port>
          <Status>Active</Status>
        </Node>
        <Node>
          <IpAddress>192.0.2.21</IpAddress>
          <Port>80</Port>
          <Status>Active</Status>
        </Node>
      </NodeList>
    </Pool>
    <Pool>
      <Name>GIO_WEB_POOL2</Name>
      <NodeList>
        <Node>
          <IpAddress>192.0.2.22</IpAddress>
          <Port>80</Port>
          <Status>Active</Status>
        </Node>
      </NodeList>
    </Pool>
  </PoolList>
</DescribeLbResponse>