List Load Balancers#

ロードバランサーを一覧表示します。

APIエンドポイント#

リージョン APIエンドポイント
西日本リージョン3の場合 https://loadbalancer.jp-west-3.cloud.global.fujitsu.com
東日本リージョン3の場合 https://loadbalancer.jp-east-3.cloud.global.fujitsu.com

HTTPメソッドとURI#

GET

/v2.0/lbaas/loadbalancers

HTTPステータスコード#

正常時：200

エラー時：400, 401, 500

リクエストパラメータの説明#

名前 In Type デフォルト値
/必須指定		 Description
fields query string 任意 属性を指定します。
省略した場合は、すべての属性が表示されます。
複数指定ができます。例えば、fields=id&fields=nameと指定すると、「id」と「name」の属性だけが表示されます。

レスポンスボディ（正常系）の説明#

名前 Type Description
admin_state_up boolean リソースの管理状態
「true」または「false」が表示されます。
created_at string リソースが作成された日時(UTC)のタイムスタンプ
description string リソースの説明
flavor_id uuid フレーバーID
id uuid ロードバランサーID
listeners array 関連付けられているリスナーIDの一覧
loadbalancers array ロードバランサーオブジェクトの一覧
name string リソース名
operating_status string リソースの運用状況
「ONLINE」、「OFFLINE」、「DEGRADED」または「ERROR」が表示されます。
operating_statusの詳細は「Operating Status Codes」を参照してください。
pools array 関連付けられているプールIDの一覧
project_id string プロジェクトID
provider string ロードバランサーの提供者の名前
provisioning_status string リソースの提供状況
「ACTIVE」、「PENDING_CREATE」、「PENDING_UPDATE」または「ERROR」が表示されます。
provisioning_statusの詳細は「Provisioning Status Codes」を参照してください。
updated_at string リソースの更新日時(UTC)のタイムスタンプ
vip_address string 仮想IP (VIP)のIPアドレス
vip_network_id uuid 仮想IP (VIP)のネットワークID
vip_port_id uuid 仮想IP (VIP)のポートID
vip_qos_policy_id uuid 仮想IP (VIP)に適用されるQoSポリシーのID
vip_subnet_id uuid 仮想IP (VIP)のサブネットID

レスポンス例#

{
    "loadbalancers": [
        {
            "admin_state_up": true,
            "created_at": "2019-02-14T01:57:43",
            "description": "",
            "flavor_id": "",
            "id": "3bd3e1bb-bde8-410c-b77e-4c6281c2755e",
            "listeners": [
                {
                    "id": "89e691bd-f54a-4fd2-bbbc-4ff80d065d89"
                }
            ],
            "name": "Loadbalancer1",
            "operating_status": "ONLINE",
            "pools": [
                {
                    "id": "a2b550fa-12a1-4781-9b3a-2c88cf3bee5c"
                }
            ],
            "project_id": "51ed616c4bf0440ab6cfe5ff96edce91",
            "provider": "octavia",
            "provisioning_status": "ACTIVE",
            "updated_at": "2019-03-08T02:39:48",
            "vip_address": "192.168.0.11",
            "vip_network_id": "61200693-0812-4cbf-9ce1-5d2e872bd9bc",
            "vip_port_id": "44befae0-28b8-46c7-b2de-1ed49c721b24",
            "vip_qos_policy_id": null,
            "vip_subnet_id": "6dd92e5d-f5c5-4527-9308-2a3f9e5ebf36"
        }
    ]
}