Update router#

仮想ルータを更新します。

APIエンドポイント#

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

HTTPメソッドとURI#

PUT

/v2.0/routers/{router_id}

HTTPステータスコード#

正常時：200

エラー時：400, 401, 404, 412

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

名前	In	Type	デフォルト値 /必須指定	Description
router	body	object	必須	仮想ルータのオブジェクト
name	body	string	必須	リソース名
admin_state_up	body	boolean	必須	リソースの管理状態「up(true)」または「down(false)」が表示されます。 📒注: このパラメータの機能はサポートしていません。
router_id	path	string	必須	仮想ルータのID
description	body	string	任意	リソースの説明
nuage_underlay	body	string	任意	SNAT通信可否 SNAT通信なしの場合は「off」、SNAT通信ありの場合は「snat」を指定します。
external_gateway_info	body	object	任意	外部ゲートウェイの情報外部ゲートウェイを設定する場合は、本パラメータ内に「network_id」パラメータを指定します。
routes	body	array	任意	仮想ルータのルーティング情報 📒注: ‐ ルータに既存のルーティング情報がある場合、設定変更時に既存のルーティング情報を含むすべての情報を記載してください。記載されていないルーティング情報は削除されます。 ‐ レスポンスボディに設定される「rd」パラメータをリクエストで指定すると、レスポンスがエラーとなるため指定しないでください。

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

名前	Type	Description
router	object	仮想ルータのオブジェクト
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通信可否
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	仮想ルータのルーティング情報 📒注: SSL-VPN接続の作成時、仮想ルータへ自動的に追加された静的ルータ設定（Nexthop：192.168.80.4、Destination：クライアントアドレスプール）を削除しないでください。
destination	string	宛先のCIDR
nexthop	string	宛先に到達するために次に転送すべき隣接するIPアドレス仮想ルータが接続しているサブネットに存在する必要があります。
distributed	boolean	分散ルータの場合は「true」
ha	boolean	高可用性の場合は、「true」
availability_zone_hints	array	仮想ルータのアベイラビリティゾーンの候補者
availability_zones	array	仮想ルータのアベイラビリティゾーン

リクエスト例#

{
    "router": {
        "distributed": false,
        "nuage_underlay": "snat",
        "external_gateway_info": {
            "network_id": "ae34051f-aa6c-4c75-abf5-50dc9ac99ef3"
        },
        "routes": [
            {
                "destination": "179.24.1.0/24",
                "nexthop": "172.24.3.99"
            }
        ]
    }
}

レスポンス例#

{
    "router": {
        "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"
                }
            ],
            "network_id": "ae34051f-aa6c-4c75-abf5-50dc9ac99ef3"
        },
        "ha": false,
        "id": "f8a44de0-fc8e-45df-93c7-f79bf3b01c95",
        "name": "router1",
        "revision_number": 3,
        "routes": [
            {
                "destination": "179.24.1.0/24",
                "rd": "65534:58661",
                "nexthop": "172.24.3.99"
            }
        ],
        "status": "ACTIVE",
        "project_id": "0bd18306d801447bb457a46252d82d13",
        "tenant_id": "0bd18306d801447bb457a46252d82d13"
    }
}