Create port#

ネットワークにポートを作成します。

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

HTTPステータスコード#

正常時：201

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

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

名前	In	Type	デフォルト値 /必須指定	Description
port	body	object	必須	ポートのオブジェクト
admin_state_up	body	boolean	true 任意	リソースの管理状態「up(true)」または「down(false)」が表示されます。
allowed_address_pairs	body	array	任意	Allowed-address-pairとして通信許可するIPアドレスとMACアドレスのペアのリストポートに接続したサーバはallowed-address-pairにマッチするIPアドレスをソースアドレスとするパケットを送信できます。 📒注: - IPアドレスは必須です。MACアドレスを省略した場合、ポートに既設のMACアドレスが使用されます。 - IPアドレスはCIDR形式でも指定可能です。ただし、VIPへの指定はできません。 - サブネット上の仮想サーバのIPアドレス、router interfaceのIPアドレス、および他のポートと重複するIPアドレスは指定しないでください。当該IPアドレスの通信ができなくなる場合があります。重複したIPアドレスを指定した際は、一度allowed address pairsに空配列を指定してポートを更新後、再試行してください。 - ポートの接続先のサブネットが仮想ルータに接続されていない場合、allowed_address_pairsを指定しないでください。
binding:vnic_type	body	string	normal 任意	ポートに紐付けられている仮想NIC種別「normal」、「direct」、または「baremetal」のどれかが指定できます。 📒注: ベアメタルインスタンスにアタッチするポートの場合は必ず「baremetal」を指定してください。
description	body	string	null 任意	リソースの説明
device_owner	body	string	任意	このポートを使用するエンティティのID
extra_dhcp_opts	body	array	任意	DHCPオプションの「opt_value」と「opt_name」のペア extra_dhcp_optsはportのDHCP optionに対して、拡張するパラメータです。例えば、portのtftp-server、DNS-serverなど設定できます。 - opt_name DHCPの特定オプション指定されたオプションはポートに反映されます。例：bootfile-name, server-ip-address, tftp-server - opt_value 「opt_name」の属性の値例： - `"extra_dhcp_opts":[{"opt_value":"0","opt_name":"router"}]` GatewayのDefault Routeの取得を禁止します。 - `"extra_dhcp_opts": [{"opt_value": "{dns_server}", "opt_name": "dns-server"}]` 仮想サーバに対して固定でDNSのアドレスを設定します。 extra_dhcp_optsのオプションはDHCPプロトコルのオプションと同じです。 DHCPプロトコルのオプションの詳しい情報は以下を参照してください。 http://tools.ietf.org/html/rfc2132
fixed_ips	body	array	任意	ポートのIPアドレス IPアドレスとサブネットIDが含まれます。 IPを省略する場合は、指定するサブネットから利用可能なIPアドレスが自動的に割り当てられます。サブネットIDを省略する場合は、指定するIPアドレスが存在するサブネットからIPアドレスが割り当てられます。
mac_address	body	string	任意	ポートのMACアドレス 📒注: MACアドレス指定はポリシー上、ネットワークの所有者でしか使用できないパラメータです。network RBACで共有したネットワークの共有先でcreate portを実行する場合には、MACアドレスの指定はできません。
name	body	string	null 任意	リソース名
network_id	body	string	必須	関連付けられているネットワークのID
port_security_enabled	body	boolean	任意	ネットワークのポートセキュリティの有効/無効を表示します。有効の場合は「true」で、無効の場合は「false」です。この値は、新規ポートを作成するときに設定されます。
project_id	body	string	任意	リソースの所有者のプロジェクトID 管理者ユーザーだけは自分が所属するプロジェクト以外のプロジェクトIDを指定可能です。認証ポリシーでこのポリシーを変更することはできません。
security_groups	body	array	任意	ポートに適用されているセキュリティグループのID
tenant_id	body	string	任意	リソースの所有者のプロジェクトID 管理者ユーザーだけは自分が所属するプロジェクト以外のプロジェクトIDを指定可能です。認証ポリシーでこのポリシーを変更することはできません。

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

名前	Type	Description
port	object	ポートのオブジェクト
admin_state_up	boolean	リソースの管理状態「up(true)」または「down(false)」が表示されます。
allowed_address_pairs	array	Allowed-address-pairとして通信許可するIPアドレスとMACアドレスのペアのリストポートに接続したサーバはallowed-address-pairにマッチするIPアドレスをソースアドレスとするパケットを送信できます。 📒注: - IPアドレスは必須です。MACアドレスを省略した場合、ポートに既設のMACアドレスが使用されます。 - IPアドレスはCIDR形式でも指定可能です。ただし、VIPへの指定はできません。 - サブネット上の仮想サーバのIPアドレスおよび、router interfaceのIPアドレス、他のポートと重複するIPアドレスは指定しないでください。当該IPアドレスの通信ができなくなる場合があります。重複したIPアドレスを指定した際は、一度allowed address pairsに空配列を指定してポートを更新後、再試行してください。
binding:host_id	string	ポートが存在するホストのID
binding:profile	string	ホスト上に起動するアプリケーションをIaaSのネットワーク構成特有のVIFポート情報の送受信を可能にします。形式はAPI側で定義されていません。
binding:vif_details	object	ポートの詳細情報
port_filter	boolean	ポートフィルタリング機能が利用可能かどうかを表示します。
ovs_hybrid_plug	boolean	OVSなどのハイブリッドプラグを利用する必要があるかどうかを表示します。
binding:vif_type	string	ポートに接続するために利用するメカニズム「ovs」、「bridge」、「macvtap」、「hw_veb」、「hostdev_physical」、「vhostuser」、「distributed」、と「other」また、特別な値として「unbound」と「binding_failed」があります。「unbound」の場合は、ポートはIaaSのネットワーク構成に関連付けられていません。「binding_failed」はIaaSのネットワーク構成への関連付けにエラーが発生したことを表します。
binding:vnic_type	string	ポートに紐付けられている仮想NIC種別「normal」、「direct」、または「baremetal」のどれかが表示されます。
created_at	string	リソースの作成日時
data_plane_status	string	ポートのデータプレーンのステータス
description	string	リソースの説明
device_id	string	このポートを使用するデバイスのID
device_owner	string	このポートを使用するエンティティのID
dns_assignment	object	IPアドレスとFQDNを含むDNSに割り当てられたポートの情報
extra_dhcp_opts	array	DHCPオプションの「opt_value」と「opt_name」のペア extra_dhcp_optsはportのDHCP optionに対して、拡張するパラメータです。例えば、portのtftp-server、DNS-serverなど設定できます。 - opt_name DHCPの特定オプション指定されたオプションはポートに反映されます例：bootfile-name, server-ip-address, tftp-server - opt_value 「opt_name」の属性の値例： - `"extra_dhcp_opts":[{"opt_value":"0","opt_name":"router"}]` GatewayのDefault Routeの取得を禁止します。 - `"extra_dhcp_opts": [{"opt_value": "{dns_server}", "opt_name": "dns-server"}]` 仮想サーバに対して固定でDNSのアドレスを設定します。 extra_dhcp_optsのオプションはDHCPプロトコルのオプションと同じです。 DHCPプロトコルのオプションの詳しい情報は以下を参照してください。 http://tools.ietf.org/html/rfc2132
fixed_ips	array	ポートのIPアドレス各項目にIPアドレスとサブネットのIDが入っています。
id	string	リソースのID
ip_allocation	string	ポートのIP割り当て immediate(即時)、deferred(延期）またはnone(なし)が表示されます。
mac_address	string	ポートのMACアドレス
name	string	リソース名
network_id	string	関連付けられているネットワークのID
port_security_enabled	boolean	ネットワークのポートセキュリティの有効/無効を表示します。有効の場合は「true」で、無効の場合は「false」です。この値は、新規ポートを作成するときに設定されます。
project_id	string	プロジェクトのID
revision_number	integer	リソースの改訂番号
security_groups	array	ポートに適用されているセキュリティグループのID
status	string	ポートのステータス「ACTIVE」、「DOWN」、「BUILD」または「ERROR」のどれかが表示されます。
tenant_id	string	プロジェクトのID
updated_at	string	ポートの更新日時

リクエスト例#

{
    "port": {
        "admin_state_up": true,
        "name": "private-port",
        "network_id": "a87cc70a-3e15-4acf-8205-9b711a3531b7",
        "port_security_enabled": true,
        "allowed_address_pairs": [
            {
                "ip_address": "12.12.11.12",
                "mac_address": "fa:14:2a:b3:cb:f0"
            }
        ]
    }
}

レスポンス例#

{
    "port": {
        "admin_state_up": true,
        "allowed_address_pairs": [
            {
                "ip_address": "12.12.11.12",
                "mac_address": "fa:14:2a:b3:cb:f0"
            }
        ],
        "created_at": "2016-03-08T20:19:41",
        "data_plane_status": null,
        "description": "",
        "device_id": "",
        "device_owner": "",
        "dns_assignment": {
            "hostname": "myport",
            "ip_address": "10.0.0.2",
            "fqdn": "myport.my-domain.org"
        },
        "extra_dhcp_opts": [
            {
                "opt_value": "pxelinux.0",
                "ip_version": 4,
                "opt_name": "bootfile-name"
            }
        ],
        "fixed_ips": [
            {
                "ip_address": "10.0.0.2",
                "subnet_id": "a0304c3a-4f08-4c43-88af-d796509c97d2"
            }
        ],
        "id": "65c0ee9f-d634-4522-8954-51021b570b0d",
        "ip_allocation": "immediate",
        "mac_address": "fa:16:3e:c9:cb:f0",
        "name": "private-port",
        "network_id": "a87cc70a-3e15-4acf-8205-9b711a3531b7",
        "port_security_enabled": true,
        "project_id": "d6700c0c9ffa4f1cb322cd4a1f3906fa",
        "revision_number": 1,
        "security_groups": [
            "f0ac4394-7e4a-4409-9701-ba8be283dbc3"
        ],
        "status": "DOWN",
        "tenant_id": "d6700c0c9ffa4f1cb322cd4a1f3906fa",
        "updated_at": "2016-03-08T20:19:41"
    }
}