Create port

URI

/v2.0/ports

HTTPメソッド

POST

リクエストパラメタ

キー	説明	型	必須/省略可
name	ポートID	xsd:string	Optional
allowed_address_pairs	許可されているアドレスペア ip_addressに、全通信を許可する "0.0.0.0/0" は指定できません。	xsd:dict	Optional
admin_state_up	ポートの管理状態。ポートが稼動中(true)か停止している(false)かを示します。	xsd:bool	Optional
mac_address	MACアドレス。有効でないアドレスを指定した場合、400 Bad Requestエラーが返されます。MACアドレスを指定しなければ、自動で割り当てられます。エラーが発生した場合、503 Service Unavailable エラーが返されます。	xsd:string	Optional
fixed_ips	サブネットIDだけを指定した場合、そのサブネットから利用可能なIPがポートに割り当てられます。サブネットIDとIPアドレスの両方を指定した場合、指定されたアドレスがポートに割り当てられます。	xsd:dict	Optional
security_groups	セキュリティグループ。セキュリティグループIDを1つ以上指定してください。	csapi:uuid	Optional (注意)
network_id	ネットワークID	csapi:uuid	Required
availability_zone	アベイラビリティゾーン名指定しなかった場合、リソースはデフォルトのアベイラビリティゾーンに作成されます。	xsd:string	Optional

注意:

security_groupsを省略した場合、プロジェクト内のデフォルトのSecurityGroupが指定されます。

注意:

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

注意:

subnet作成後の最初のportの追加は連続して行なわず、APIの応答を受け取った後に発行してください。

リクエスト例


{
    "port": {
        "network_id": "a87cc70a-3e15-4acf-8205-9b711a3531b7",
        "name": "private-port",
        "admin_state_up": true,
        "availability_zone": "AZ1"
    }
}

レスポンスステータス

ステータスコード	説明
201	Normal response codes
badRequest (400)	Error response codes
unauthorized (401)	Error response codes
forbidden (403)	Error response codes
itemNotFound (404)	Error response codes
macGenerationFailure (503)	Error response codes
serviceUnavailable (503)	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	ポートに紐付けられている仮想NIC種別。値は次のいずれかです。 normal(仮想NIC) direct(PCIパススルー) macvtap(TAPに似たソフトウェアインターフェースを持つ仮想インターフェース)
availability_zone	アベイラビリティゾーン名