List load balancers#
ロードバランサーを一覧表示します。
📒注: 本APIは非推奨です。「List Load Balancers」をご利用ください。
APIエンドポイント#
リージョン | APIエンドポイント |
---|---|
西日本リージョン3の場合 | https://networking.jp-west-3.cloud.global.fujitsu.com |
東日本リージョン3の場合 | https://networking.jp-east-3.cloud.global.fujitsu.com |
HTTPメソッドとURI#
GET
/v2.0/lbaas/loadbalancers
HTTPステータスコード#
正常時:200
エラー時:401
リクエストパラメータの説明#
名前 | In | Type | デフォルト値 /必須指定 |
Description |
---|---|---|---|---|
fields | query | string | 任意 | 属性を指定します。 省略した場合は、すべての属性が表示されます。 複数指定ができます。例えば、 fields=id&fields=name と指定すると、「id」と「name」の属性だけが表示されます。 |
レスポンスボディ(正常系)の説明#
名前 | Type | Description |
---|---|---|
admin_state_up | boolean | リソースの管理状態 「up(true)」または「down(false)」が表示されます。 |
description | string | リソースの説明 |
flavor | string | フレーバーID |
id | string | ロードバランサーID |
listeners | array | 関連付けられているリスナーのID(存在する場合にだけ表示) |
loadbalancers | array | ロードバランサーオブジェクトの一覧 |
name | string | リソース名 |
operating_status | string | リソースの運用状況 「ONLINE」または「OFFLINE」です。 |
pools | array | プールオブジェクトの一覧 |
project_id | string | プロジェクトID |
provider | string | ロードバランサーの提供者の名前 |
provisioning_status | string | リソースの提供状況 「ACTIVE」、「PENDING_CREATE」または「ERROR」です。 |
tenant_id | string | プロジェクトID |
vip_address | string | 仮想IP(VIP)のIPアドレス 📒注: ロードバランサーがバックエンドのメンバーと通信するためのIPアドレスは、本項目に指定された仮想IPアドレスとは異なります。なお、バックエンドのメンバーと通信するためのIPアドレスは、参照および変更できません。 |
vip_subnet_id | string | 仮想IP(VIP)のサブネットID |
レスポンス例#
{ "loadbalancers": [ { "description": "simple lb", "admin_state_up": true, "project_id": "1a3e005cf9ce40308c900bcb08e5320c", "tenant_id": "1a3e005cf9ce40308c900bcb08e5320c", "provisioning_status": "ACTIVE", "listeners": [], "vip_address": "10.0.0.2", "vip_subnet_id": "013d3059-87a4-45a5-91e9-d721068ae0b2", "id": "a9729389-6147-41a3-ab22-a24aed8692b2", "operating_status": "ONLINE", "name": "loadbalancer1", "flavor": "a7ae5d5a-d855-4f9a-b187-af66b53f4d04", "provider": "sample-provider", "pools": [] } ] }