GetLbHostList

API情報

API種別 Action 対象 名称 実行
設定 GetLbHostList FW/LB LBホスト情報取得  

リクエストパラメータ

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

レスポンス

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

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

値: Yes, No

GetLbHostListResponse.HostList Array FW+LBオプションを構成するホストのリスト
GetLbHostListResponse.HostList.Location String

ホストのロケーション

値: L, R

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

GetLbHostListResponse.HostList.SoftwareVersion String

ロードバランサのソフトウェアバージョン

参考:C-4.3 LBのバージョンアップ

GetLbHostListResponse.HostList.GlobalIpAddress.IPv4Address String グローバルIPv4アドレス
GetLbHostListResponse.HostList.GlobalIpAddress.IPv6Address String グローバルIPv6アドレス
GetLbHostListResponse.HostListPrivateIpAddress.IPv4Address String プライベートIPv4アドレス

エラーコード

制限

サンプル

リクエスト

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

レスポンス (JSON)

Json
{
    "GetLbHostListResponse": {
        "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
        "GlServiceCode": "gl########",
        "Label": "XXXXX",
        "Type": "B10M",
        "Redundant": "Yes",
        "HostList": [
            {
                "Location": "L",
                "SoftwareVersion": "9.0r3",
                "GlobalAddress": {
                    "IPv4Address": "203.0.113.21",
                    "IPv6Address": "2001:0db8:0000:0000:0000:0000:000b:0001"
                },
                "PrivateAddress": {
                    "IPv4Address": "192.0.2.21"
                }
            },
            {
                "Location": "R",
                "SoftwareVersion": "9.0r3",
                "GlobalAddress": {
                    "IPv4Address": "203.0.113.22",
                    "IPv6Address": "2001:0db8:0000:0000:0000:0000:000b:0002"
                },
                "PrivateAddress": {
                    "IPv4Address": "192.0.2.22"
                }
            }
        ]
    }
}

レスポンス (XML)

XML
<?xml version="1.0" encoding="UTF-8"?>
<GetLbHostListResponse>
  <RequestId>xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx</RequestId>
  <GlServiceCode>gl########</GlServiceCode>
  <Label>XXXXX</Label>
  <Type>B10M</Type>
  <Redundant>Yes</Redundant>
  <HostList>
    <Host>
      <Location>L</Location>
      <SoftwareVersion>9.0r3</SoftwareVersion>
      <GlobalAddress>
        <IPv4Address>203.0.113.21</IPv4Address>
        <IPv6Address>2001:0db8:0000:0000:0000:0000:000b:0001</IPv6Address>
      </GlobalAddress>
      <PrivateAddress>
        <IPv4Address>192.0.2.21</IPv4Address>
      </PrivateAddress>
    </Host>
    <Host>
      <Location>R</Location>
      <SoftwareVersion>9.0r3</SoftwareVersion>
      <GlobalAddress>
        <IPv4Address>203.0.113.22</IPv4Address>
        <IPv6Address>2001:0db8:0000:0000:0000:0000:000b:0002</IPv6Address>
      </GlobalAddress>
      <PrivateAddress>
        <IPv4Address>192.0.2.22</IPv4Address>
      </PrivateAddress>
    </Host>
  </HostList>
</GetLbHostListResponse>