Update port

URI

/v2.0/ports/{port_id}

URIの説明:

ポートID

HTTPメソッド

PUT

リクエストパラメタ

キー	説明	型	必須/省略可
name	ポートID	xsd:string	Optional
allowed_address_pairs	通信を許可するアドレスペアリスト。ip_addressとmac_addressの組み合わせを以下のように指定します。 `"allowed_address_pairs": [ { "ip_address": "10.110.0.0/24", "mac_address": "fa:ff:ff:ff:ff:ff" }, { "ip_address": "10.0.0.5", "mac_address": "fa:ff:ff:ff:ff:ff" } ]` ip_addressには、IPアドレス、または、ネットワークアドレス(CIDR)を指定できます。全通信を許可する"0.0.0.0/0"は指定できません。 mac_addressを省略した場合、portのMACアドレスが設定されます。	xsd:dict	Optional
admin_state_up	ポートの管理状態ポートが稼動中(true)か停止している(false)かを示します。	xsd:bool	Optional
fixed_ips	サブネットIDだけを指定した場合、そのサブネットから利用可能なIPがポートに割り当てられます。サブネットIDとIPアドレスの両方を指定した場合、指定されたアドレスがポートに割り当てられます。注意: 以下に該当するポートの場合、APIでポートのIPアドレスを変更することはできません。意図した通信ができなくなるため、このパラメタは指定しないでください。ポートがFloating IPと関連付けられている場合 "device_owner"が"network:dhcp"の場合 "device_owner"が"network:router_interface"の場合	xsd:dict	Optional
security_groups	セキュリティグループセキュリティグループIDを1つ以上指定してください。	csapi:uuid	Optional

注意:

Windows仮想サーバ for SAP サービスで利用するportの場合、fixed_ipsには、network_idに関連づいたsubnetのallocation_poolsおよびgateway_ipで指定したIPアドレスが指定可能です。

リクエスト例


{
    "port": {
        "name": "private-port",
        "admin_state_up": true
    }
}

レスポンスステータス

ステータスコード	説明
200	Normal response codes
badRequest (400)	Error response codes
unauthorized (401)	Error response codes
forbidden (403)	Error response codes
itemNotFound (404)	Error response codes
conflict (409)	Error response codes

レスポンスボディ(正常系)


{
    "port": {
        "status": "DOWN",
        "name": "private-port",
        "allowed_address_pairs": [],
        "admin_state_up": true,
        "network_id": "a87cc70a-3e15-4acf-8205-9b711a3531b7",
        "tenant_id": "d6700c0c9ffa4f1cb322cd4a1f3906fa",
        "binding:vnic_type": "normal",
        "device_owner": "",
        "mac_address": "fa:16:3e:c9:cb:f0",
        "fixed_ips": [
            {
                "subnet_id": "a0304c3a-4f08-4c43-88af-d796509c97d2",
                "ip_address": "10.0.0.2"
            }
        ],
        "id": "65c0ee9f-d634-4522-8954-51021b570b0d",
        "security_groups": [
            "f0ac4394-7e4a-4409-9701-ba8be283dbc3"
        ],
        "device_id": "",
        "availability_zone": "AZ1"
    }
}

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

要素名	説明
status	ポートのステータス値は"ACTIVE"または"DOWN"です。
name	ポート名
allowed_address_pairs	通信を許可したアドレスペアリスト
admin_state_up	ルーターの管理状態ルーターが稼動中(true)か停止している(false)かを示します。
network_id	アタッチされているネットワークのID
tenant_id	ネットワークを所有しているプロジェクトID
extra_dhcp_opts	追加のDHCPオプション
device_owner	このポートを使用するエンティティのID 例: DHCPエージェント
mac_address	ポートのMACアドレス
fixed_ips	ポートのIPアドレス IPアドレスとサブネットIDが含まれます。
id	ポートID
security_groups	アタッチされているセキュリティグループのID
device_id	このポートを使用するデバイスのID 例: 仮想サーバ
binding:vnic_type	値は次のいずれかです。 normal(仮想NIC) direct(PCIパススルー) macvtap(TAPに似たソフトウェアインターフェースを持つ仮想インターフェース)
availability_zone	アベイラビリティゾーン名