ロードバランス先情報一覧取得

API情報
API種別メソッドURI対象名称実行
設定GET/:GisServiceCode/best-effort-fw-lbs/:IlbServiceCode/lb/destinations.jsonFW+LBベストエフォートタイプロードバランス先情報一覧取得同期
  • 指定されたFW+LB ベストエフォートタイプのロードバランス先情報一覧を取得します


リクエストパラメータ

パラメータ必須意味
URL
GisServiceCodeP2契約のサービスコードgis########

IlbServiceCodeFW+LB ベストエフォートタイプのサービスコードilb########
レスポンス
フィールドタイプ意味
DestinationListArrayロードバランス先情報ロードバランス先情報
DestinationList.IdStringロードバランス先IDロードバランス先ID
DestinationList.LbConfigIdStringロードバランシング設定のIDロードバランシング設定のID
DestinationList.IpAddressStringロードバランス先アドレスロードバランス先アドレス
DestinationList.PortStringロードバランス先ポート番号ロードバランス先ポート番号
DestinationList.WeightString

ロードバランス先重み

Failover がYesのときは空

数字
DestinationList.FailoverStringフェールオーバー先"Yes" "No"
DestinationList.EnabledString有効・無効"Yes" "No"
DestinationList.HealthCheckStatusStringヘルスチェックステータス

ロードバランス先のヘルスチェック状態

Success: 正常

Failed: 異常

Disable: 無効(Enabled: No)

Unknown: FailoverがYesのときもしくは原因不明でステータス取得に失敗

None: 登録直後

エラーコード
  • このAPIに関する個別エラーはありません。
  • 共通エラーコードはエラーレスポンスを参照して下さい


制限
  • 特になし


サンプル

リクエストボディ

無し 

レスポンス (JSON)

{
    "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
    "DestinationList": [
        {
            "Id": "1",
            "LbConfigId": "1",
            "IpAddress": "192.168.2.4",
            "Port": "80",
            "Weight": "100",
            "Failover": "No",
            "Enabled": "Yes",
            "HealthCheckStatus": "Success"
        },
        {
            "Id": "2",
            "LbConfigId": "1",
            "IpAddress": "192.168.2.5",
            "Port": "80",
            "Weight": "100",
            "Failover": "No",
            "Enabled": "Yes",
            "HealthCheckStatus": "Success"
        }
    ]
}