List floating IPs#

ユーザーに利用可能なフローティングIPアドレスを一覧表示します。

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/floatingips

HTTPステータスコード#

正常時:200

エラー時:401

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

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

レスポンスボディ(正常系)の説明#

名前 Type Description
floatingips array フローティングIPのオブジェクト
id string フローティングIPのID
router_id string 仮想ルータのID
status string フローティングIPのステータス
「ACTIVE」、「DOWN」、「ERROR」のどれかが表示されます。
tenant_id string プロジェクトのID
project_id string プロジェクトのID
created_at string リソースの作成日時(UTC ISO8601形式)
updated_at string リソースの最終更新日(UTC ISO8601形式)
revision_number integer リソースの改訂番号
description string リソースの説明
dns_domain string 有効なDNSのドメイン
dns_name string 有効なDNSネーム
floating_network_id string フローティングIPに関連付けられているネットワークのID
fixed_ip_address string フローティングIPに関連付けられている固定IPアドレスID
floating_ip_address string フローティングIPアドレス
port_id string フローティングIPに関連付けられているポートのID

レスポンス例#

{
    "floatingips": [
        {
            "router_id": "d23abc8d-2991-4a55-ba98-2aaea84cc72f",
            "description": "for test",
            "dns_domain": "my-domain.org.",
            "dns_name": "myfip",
            "created_at": "2016-12-21T10:55:50Z",
            "updated_at": "2016-12-21T10:55:53Z",
            "revision_number": 1,
            "project_id": "4969c491a3c74ee4af974e6d800c62de",
            "tenant_id": "4969c491a3c74ee4af974e6d800c62de",
            "floating_network_id": "376da547-b977-4cfe-9cba-275c80debf57",
            "fixed_ip_address": "10.0.0.3",
            "floating_ip_address": "172.24.4.228",
            "port_id": "ce705c24-c1ef-408a-bda3-7bbd946164ab",
            "id": "2f245a7b-796b-4f26-9cf9-9e82d248fda7",
            "status": "ACTIVE"
        },
        {
            "router_id": null,
            "description": "for test",
            "dns_domain": "my-domain.org.",
            "dns_name": "myfip2",
            "created_at": "2016-12-21T11:55:50Z",
            "updated_at": "2016-12-21T11:55:53Z",
            "revision_number": 2,
            "project_id": "4969c491a3c74ee4af974e6d800c62de",
            "tenant_id": "4969c491a3c74ee4af974e6d800c62de",
            "floating_network_id": "376da547-b977-4cfe-9cba-275c80debf57",
            "fixed_ip_address": null,
            "floating_ip_address": "172.24.4.227",
            "port_id": null,
            "id": "61cea855-49cb-4846-997d-801b70c71bdd",
            "status": "DOWN"
        }
    ]
}