Show port details#

ポートの詳細情報を表示します。

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/{port_id}

HTTPステータスコード#

正常時:200

エラー時:401, 404

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

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

レスポンスボディ(正常系)の説明#

名前 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への指定はできません。
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 ポートの更新日時

レスポンス例#

{
    "port": {
        "admin_state_up": true,
        "allowed_address_pairs": [],
        "created_at": "2016-03-08T20:19:41",
        "data_plane_status": "ACTIVE",
        "description": "",
        "device_id": "5e3898d7-11be-483e-9732-b2f5eccd2b2e",
        "device_owner": "network:router_interface",
        "dns_assignment": {
            "hostname": "myport",
            "ip_address": "10.0.0.1",
            "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": "10.0.0.1",
                "subnet_id": "a0304c3a-4f08-4c43-88af-d796509c97d2"
            }
        ],
        "id": "46d4bfb9-b26e-41f3-bd2e-e6dcc1ccedb2",
        "ip_allocation": "immediate",
        "mac_address": "fa:16:3e:23:fd:d7",
        "name": "",
        "network_id": "a87cc70a-3e15-4acf-8205-9b711a3531b7",
        "port_security_enabled": false,
        "project_id": "7e02058126cc4950b75f9970368ba177",
        "revision_number": 1,
        "security_groups": [],
        "status": "ACTIVE",
        "tenant_id": "7e02058126cc4950b75f9970368ba177",
        "updated_at": "2016-03-08T20:19:41"
    }
}