Create 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#
POST
/v2.0/routers
HTTPステータスコード#
正常時:201
エラー時:400, 401
リクエストパラメータの説明#
名前 | In | Type | デフォルト値 /必須指定 |
Description |
---|---|---|---|---|
router | body | object | 必須 | 仮想ルータのオブジェクト |
tenant_id | body | string | 任意 | リソースの所有者のプロジェクトID 管理者ユーザーだけは自分が所属するプロジェクト以外のプロジェクトIDを指定可能です。認証ポリシーでこのポリシーを変更することはできません。 |
project_id | body | string | 任意 | リソースの所有者のプロジェクトID 管理者ユーザーだけは自分が所属するプロジェクト以外のプロジェクトIDを指定可能です。認証ポリシーでこのポリシーを変更することはできません。 |
name | body | string | null 任意 |
リソース名 |
description | body | string | null 任意 |
リソースの説明 |
nuage_underlay | body | string | off 任意 |
SNAT通信可否 SNAT通信なしの場合は「off」、SNAT通信ありの場合は「snat」を指定します。 |
external_gateway_info | body | object | 任意 | 外部ゲートウェイの情報 外部ゲートウェイを設定する場合は、本パラメータ内に「network_id」パラメータを指定します。 |
network_id | body | string | 必須 | ゲートウェイが接続されているネットワークのID |
availability_zone_hints | body | array | 任意 | 仮想ルータのアベイラビリティゾーンの候補者 |
レスポンスボディ(正常系)の説明#
名前 | 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 | 仮想ルータのルーティング情報 |
destination | string | 宛先のCIDR |
nexthop | string | 宛先に到達するために次に転送すべき隣接するIPアドレス 仮想ルータが接続しているサブネットに存在する必要があります。 |
distributed | boolean | 分散ルータの場合は、「true」です。 |
ha | boolean | 高可用性の場合は、「true」です。 |
availability_zone_hints | array | 仮想ルータのアベイラビリティゾーンの候補者 |
availability_zones | array | 仮想ルータのアベイラビリティゾーン |
リクエスト例#
{ "router": { "name": "router1", "nuage_underlay": "off", "admin_state_up": true } }
レスポンス例#
{ "router": { "admin_state_up": true, "availability_zone_hints": [], "availability_zones": [ "nova" ], "description": "", "distributed": false, "nuage_underlay": "off", "external_gateway_info": {}, "ha": false, "id": "f8a44de0-fc8e-45df-93c7-f79bf3b01c95", "name": "router1", "routes": [], "revision_number": 1, "status": "ACTIVE", "project_id": "0bd18306d801447bb457a46252d82d13", "tenant_id": "0bd18306d801447bb457a46252d82d13" } }