List ports#

ユーザーがアクセスできるポートを一覧表示します。

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

HTTPステータスコード#

正常時：200

エラー時：401

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

名前	In	Type	デフォルト値 /必須指定	Description
fields	query	string	任意	属性を指定します。省略した場合は、すべての属性が表示されます。複数指定ができます。例えば、「fields=id&fields=name」を指定すると、「id」と「name」の属性だけが表示できます。 📒注: 対象のプロジェクトにロードバランサーが存在する場合、またはRBACで他のプロジェクトにネットワークを共有している場合には、対象のプロジェクトと異なる他のプロジェクトのポート（ロードバランサーのバックエンド用ポートや、共有先プロジェクトで作成されたポート）も合わせて参照できます。上記のような場合、クエリパラメータとして下記のように、tenant_idを指定することで対象のプロジェクトのポートだけを表示できます。 /v2.0/ports?tenant_id={対象のプロジェクトID}

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

名前	Type	Description
ports	array	ポートのオブジェクト
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への指定はできません。
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」、「macvtap」、「direct」、「baremetal」、「direct-physical」、または「virtio-forwarder」のどれかが表示されます。
created_at	string	リソースの作成日時
data_plane_status	string	ポートのデータプレーンのステータス
description	string	リソースの説明
device_id	string	このポートを使用するデバイスのID
device_owner	string	このポートを使用するエンティティのID
dns_assignment	object	IPアドレスとFQDNを含むDNSに割り当てられたポートの情報
dns_domain	string	有効なDNSのドメイン
dns_name	string	有効な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	ポートの更新日時

レスポンス例#

{
    "ports": [
        {
            "admin_state_up": true,
            "allowed_address_pairs": [],
            "data_plane_status": null,
            "description": "",
            "device_id": "9ae135f4-b6e0-4dad-9e91-3c223e385824",
            "device_owner": "network:router_gateway",
            "dns_assignment": {
                "hostname": "myport",
                "ip_address": "172.24.4.2",
                "fqdn": "myport.my-domain.org"
            },
            "dns_domain": "my-domain.org.",
            "dns_name": "myport",
            "extra_dhcp_opts": [
            {
                "opt_value": "pxelinux.0",
                "ip_version": 4,
                "opt_name": "bootfile-name"
            }
            ],
            "fixed_ips": [
                {
                    "ip_address": "172.24.4.2",
                    "subnet_id": "008ba151-0b8c-4a67-98b5-0d2b87666062"
                }
            ],
            "id": "d80b1a3b-4fc1-49f3-952e-1e2ab7081d8b",
            "ip_allocation": "immediate",
            "mac_address": "fa:16:3e:58:42:ed",
            "name": "",
            "network_id": "70c1db1f-b701-45bd-96e0-a313ee3430b3",
            "project_id": "",
            "revision_number": 1,
            "security_groups": [],
            "status": "ACTIVE",
            "tenant_id": "",
            "port_security_enabled": false
        },
        {
            "admin_state_up": true,
            "allowed_address_pairs": [],
            "data_plane_status": null,
            "description": "",
            "device_id": "9ae135f4-b6e0-4dad-9e91-3c223e385824",
            "device_owner": "network:router_interface",
            "dns_assignment": {
                "hostname": "myport2",
                "ip_address": "10.0.0.1",
                "fqdn": "myport2.my-domain.org"
            },
            "dns_domain": "my-domain.org.",
            "dns_name": "myport2",
            "extra_dhcp_opts": [
                {
                    "opt_value": "pxelinux.0",
                    "ip_version": 4,
                    "opt_name": "bootfile-name"
                }
            ],
            "fixed_ips": [
                {
                    "ip_address": "10.0.0.1",
                    "subnet_id": "288bf4a1-51ba-43b6-9d0a-520e9005db17"
                }
            ],
            "id": "f71a6703-d6de-4be1-a91a-a570ede1d159",
            "ip_allocation": "immediate",
            "mac_address": "fa:16:3e:bb:3c:e4",
            "name": "",
            "network_id": "f27aa545-cbdd-4907-b0c6-c9e8b039dcc2",
            "project_id": "d397de8a63f341818f198abb0966f6f3",
            "revision_number": 1,
            "security_groups": [],
            "status": "ACTIVE",
            "tenant_id": "d397de8a63f341818f198abb0966f6f3",
            "port_security_enabled": false
        }
    ]
}