Update 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#

PUT

/v2.0/ports/{port_id}

HTTPステータスコード#

正常時：200

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

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

名前	In	Type	デフォルト値 /必須指定	Description
port_id	path	string	必須	ポートのID
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」、「macvtap」、「direct」、「baremetal」、「direct-physical」、または「virtio-forwarder」のどれかが指定できます。
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アドレスが割り当てられます。 📒注: IPアドレス、またはサブネットIDのどちらかを必ず指定してください。ポートが利用できなくなる可能性があります。
name	body	string	null 任意	リソース名
port_security_enabled	body	boolean	任意	ネットワークのポートセキュリティの有効無効を表示します。有効の場合は「true」で、無効の場合は「false」です。この値は、新規ポートを作成するときに設定されます。
security_groups	body	array	任意	ポートに適用されているセキュリティグループの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:vnic_type	string	ポートに紐付けられている仮想NIC種別「normal」、「macvtap」、「direct」、「baremetal」、「direct-physical」、または「virtio-forwarder」のどれかが表示されます。
created_at	string	リソースの作成日時
description	string	リソースの説明
device_id	string	このポートを使用するデバイスのID
device_owner	string	このポートを使用するエンティティのID
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
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": "test-for-port-update"
    }
}

レスポンス例#

{
    "port": {
        "admin_state_up": true,
        "allowed_address_pairs": [],
        "binding:vnic_type": "normal",
        "description": "",
        "device_id": "",
        "device_owner": "",
        "extra_dhcp_opts": [
            {
                "opt_value": "pxelinux.0",
                "ip_version": 4,
                "opt_name": "bootfile-name"
            }
        ],
        "fixed_ips": [
            {
                "ip_address": "20.20.0.4",
                "subnet_id": "898dec4a-74df-4193-985f-c76721bcc746"
            }
        ],
        "id": "43c831e0-19ce-4a76-9a49-57b57e69428b",
        "mac_address": "fa:16:3e:11:11:5e",
        "name": "test-for-port-update",
        "network_id": "883fc383-5ea1-4c8b-8916-e1ddb0a9f365",
        "project_id": "522eda8d23124b25bf03fe44f1986b74",
        "revision_number": 1,
        "security_groups": [
            "ce0179d6-8a94-4f7c-91c2-f3038e2acbd0"
        ],
        "status": "DOWN",
        "tenant_id": "522eda8d23124b25bf03fe44f1986b74",
        "port_security_enabled": false
    }
}