List routers

仮想ルータを一覧表示します。

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

HTTPステータスコード

正常時：200

エラー時：401

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

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

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

名前	Type	Description
routers	array	仮想ルータのオブジェクト
id	string	仮想ルータのID
tenant_id	string	プロジェクトのID
project_id	string	プロジェクトのID
name	string	リソース名
description	string	リソースの説明
admin_state_up	boolean	リソースの管理状態 「up(true)」または「down(false)」が表示されます。 📒注: このパラメータの機能はサポートしていません。
status	string	仮想ルータの状態
nuage_underlay	string	SNAT通信可否 SNAT通信なしの場合は「off」、SNAT通信ありの場合は「snat」が表示されます。
external_gateway_info	object	外部ゲートウェイの情報 外部ゲートウェイがある場合は、「network_id」、「enable_snat」、「external_fixed_ips」が本パラメータ内に含まれます。外部ゲートウェイがない場合は「null」です。
network_id	string	ゲートウェイが接続されているネットワークのID
enable_snat	boolean	無効なパラメータです。常に「false」が表示されます。
external_fixed_ips	array	外部ゲートウェイのIPアドレス 各項目にIPアドレスとサブネットのIDが入っています。
revision_number	integer	リソースの改訂番号
routes	array	仮想ルータのルーティング情報
destination	string	宛先のCIDR
nexthop	string	宛先に到達するために次に転送すべき隣接するIPアドレス 仮想ルータが接続しているサブネットに存在する必要があります。
distributed	boolean	分散ルータの場合は「true」
ha	boolean	高可用性の場合は、「true」
availability_zone_hints	array	仮想ルータのアベイラビリティゾーンの候補者
availability_zones	array	仮想ルータのアベイラビリティゾーン

レスポンス例

{
    "routers": [
        {
            "admin_state_up": true,
            "availability_zone_hints": [],
            "availability_zones": [
                "nova"
            ],
            "description": "",
            "distributed": false,
            "nuage_underlay": "snat",
            "external_gateway_info": {
                "enable_snat": false,
                "external_fixed_ips": [
                    {
                        "ip_address": "172.24.4.3",
                        "subnet_id": "b930d7f6-ceb7-40a0-8b81-a425dd994ccf"
                    },
                    {
                        "ip_address": "2001:db8::c",
                        "subnet_id": "0c56df5d-ace5-46c8-8f4c-45fa4e334d18"
                    }
                ],
                "network_id": "ae34051f-aa6c-4c75-abf5-50dc9ac99ef3"
            },
            "ha": false,
            "id": "915a14a6-867b-4af7-83d1-70efceb146f9",
            "name": "router2",
            "revision_number": 1,
            "routes": [
                {
                    "destination": "179.24.1.0/24",
                    "nexthop": "172.24.3.99"
                }
            ],
            "status": "ACTIVE",
            "project_id": "0bd18306d801447bb457a46252d82d13",
            "tenant_id": "0bd18306d801447bb457a46252d82d13"
        },
        {
            "admin_state_up": true,
            "availability_zone_hints": [],
            "availability_zones": [
                "nova"
            ],
            "description": "",
            "distributed": false,
            "nuage_underlay": "snat",
            "external_gateway_info": {
                "enable_snat": false,
                "external_fixed_ips": [
                    {
                        "ip_address": "172.24.4.6",
                        "subnet_id": "b930d7f6-ceb7-40a0-8b81-a425dd994ccf"
                    },
                    {
                        "ip_address": "2001:db8::9",
                        "subnet_id": "0c56df5d-ace5-46c8-8f4c-45fa4e334d18"
                    }
                ],
                "network_id": "ae34051f-aa6c-4c75-abf5-50dc9ac99ef3"
            },
            "ha": false,
            "id": "f8a44de0-fc8e-45df-93c7-f79bf3b01c95",
            "name": "router1",
            "revision_number": 1,
            "routes": [],
            "status": "ACTIVE",
            "project_id": "0bd18306d801447bb457a46252d82d13",
            "tenant_id": "0bd18306d801447bb457a46252d82d13"
        }
    ]
}