虚拟网卡

列举网卡

功能介绍

列出租户有权访问的网卡。

URI

GET /v2.0/ports

请求消息

无

请求示例

说明：不需要指定body

响应消息

参数	参数类型	描述
ports	array	网卡列表
admin_state_up	boolean	网卡的admin状态，取值true或false。
allowed_address_pairs	array	网卡允许访问的地址pair列表，每个pair包含一个ip和mac。
binding:host_id	String	网卡所属的host id。
binding:profile	object	网卡信息字典，传递和接收用于后端网络插件处理的网卡信息。
binding:vif_details	object	网卡附加信息字典，目前主要字段是port_filter和ovs_hybrid_plug.
binding:vif_type	String	网卡绑定使用的ml2插件类型，比如ovs，bridge，macvtap，未绑定是unbound，失败是binding_failed
binding:vnic_type	String	网卡挂载的类型，比如normal，direct，baremetal
created_at	String	网卡创建时间 (in UTC ISO8601 format).
description	String	用户描述
device_id	sttring	使用该网卡的设备ID，比如一个虚机uuid
device_owner	sting	使用该网卡的设备类型，比如network：DHCP。
extra_dhcp_opts	array	额外的dhcp参数列表。
fixed_ips	array	网卡的固定ip列表。
id	String	网卡的ID。
mac_address	String	网卡的mac地址。
name	satring	网卡的名称。
network_id	String	网卡所属的网络ID。
port_security_enabled	boolean	网卡的安全状态。true或者false，如果是true将会配置安全组规则和anti-spoofing规则，否则不会处理。
project_id	String	网卡所属的project id。
qos_policy_id	String	网卡关联的qos策略id。
revision_number		网卡的版本号。
security_groups	array	网卡关联的安全组列表。
status	String	网卡的状态： ACTIVE, DOWN, BUILD and ERROR
tags	array	网卡的标签列表。
tenant_id	String	网卡所属的tenant id
updated_at	String	网卡最近更新的时间(in UTC ISO8601 format).

响应示例

{
    "ports": [
        {
            "admin_state_up": false,
            "allowed_address_pairs": [],
            "binding:host_id": "",
            "binding:profile": {},
            "binding:vif_details": {},
            "binding:vif_type": "unbound",
            "binding:vnic_type": "normal",
            "created_at": "2021-02-22T12:29:22Z",
            "description": "",
            "device_id": "",
            "device_owner": "",
            "extra_dhcp_opts": [],
            "fixed_ips": [
                {
                    "ip_address": "172.16.0.9",
                    "subnet_id": "c12ac01a-2422-473a-b297-baca99b2d690"
                }
            ],
            "id": "01a9c14a-d4bb-4b28-a5c8-fd0458b8c94e",
            "mac_address": "fa:16:3e:01:74:c7",
            "name": "kw-2_kw-test_1edaecca",
            "network_id": "328878f3-5805-42f1-82dd-40dcdd1f79f1",
            "port_security_enabled": true,
            "project_id": "8cd7d3e275584638964ff92ddd3b1596",
            "qos_policy_id": null,
            "revision_number": 5,
            "security_groups": [
                "dbd9b12d-1d79-4594-ba18-36967bc4b9ae"
            ],
            "status": "DOWN",
            "tenant_id": "8cd7d3e275584638964ff92ddd3b1596",
            "updated_at": "2021-02-22T12:29:22Z"
        },        
        {
            "admin_state_up": true,
            "allowed_address_pairs": [],
            "binding:host_id": "node-10.domain.tld",
            "binding:profile": {},
            "binding:vif_details": {
                "ovs_hybrid_plug": false,
                "port_filter": true
            },
            "binding:vif_type": "ovs",
            "binding:vnic_type": "normal",
            "created_at": "2021-02-24T02:41:53Z",
            "description": "",
            "device_id": "f9583498-c576-4e2e-86ad-c6a662b000a8",
            "device_owner": "compute:kuryr",
            "extra_dhcp_opts": [],
            "fixed_ips": [
                {
                    "ip_address": "192.168.111.12",
                    "subnet_id": "f32a3ab8-6a5a-41c6-a202-cfe7bea9348a"
                }
            ],
            "id": "04c4339b-d13f-4f14-9be5-8f7477cbea4e",
            "mac_address": "fa:16:3e:f8:72:bb",
            "name": "d717c61a2",
            "network_id": "7b0343bd-cf33-45af-bb2b-25bea12eb2c9",
            "port_security_enabled": true,
            "project_id": "d717c61a263f4a0b9271d0a271653c2a",
            "qos_policy_id": null,
            "revision_number": 8,
            "security_groups": [
                "a8c01103-2cf1-4f6a-a8f1-ed84ec2f794f"
            ],
            "status": "ACTIVE",
            "tenant_id": "d717c61a263f4a0b9271d0a271653c2a",
            "updated_at": "2021-02-24T02:42:13Z"
        }
]

正常响应代码

200

错误码

400，401，403，404，409，413

创建网卡

功能介绍

创建网卡。

URI

POST /v2.0/ports

请求消息

参数	参数类型	是否必选	描述
port	object	是	网卡对象。
admin_state_up	boolean	否	网卡的admin状态，取值true或false。
allowed_address_pairs	array	否	网卡允许访问的地址pair列表，每个pair包含一个ip和mac。
binding:host_id	String	否	网卡所属的host id。
binding:profile	object	否	网卡信息字典，传递和接收用于后端网络插件处理的网卡信息。
binding:vnic_type	String	否	网卡挂载的类型，比如normal，direct，baremetal，默认normal。
description	String	否	用户描述。
device_id	String	否	使用该网卡的设备ID，比如一个虚机uuid。
device_owner	String	否	使用该网卡的设备类型，比如network：DHCP。
extra_dhcp_opts	array	否	额外的dhcp参数列表。
fixed_ips	array	否	网卡的固定ip列表。
mac_address	String	否	网卡的mac地址。
name	satring	否	网卡的名称。
network_id	String	是	网卡所属的网络ID。
port_security_enabled	boolean	否	网卡的安全状态。true或者false，如果是true将会配置安全组规则和anti-spoofing规则，否则不会处理。
project_id	String	否	网卡所属的project id。
qos_policy_id	String	否	网卡关联的qos策略id。
security_groups	array	否	网卡关联的安全组列表。
tags	array		网卡的标签列表。
tenant_id	String		网卡所属的tenant id。

请求示例

示例：创建网卡

POST /v2.0/ports
{
    "port": {
        "admin_state_up": true,
        "name": "test",
        "network_id": "1191a2fd-42c6-44b9-b153-3378407468f2"
    }
}

响应消息

参数	参数类型	描述
port	object	网卡对象
admin_state_up	boolean	网卡的admin状态，取值true或false。
allowed_address_pairs	array	网卡允许访问的地址pair列表，每个pair包含一个ip和mac。
binding:host_id	String	网卡所属的host id。
binding:profile	object	网卡信息字典，传递和接收用于后端网络插件处理的网卡信息。
binding:vif_details	object	网卡附加信息字典，目前主要字段是port_filter和ovs_hybrid_plug。
binding:vif_type	String	网卡绑定使用的ml2插件类型，比如ovs，bridge，macvtap，未绑定是unbound，失败是binding_failed。
binding:vnic_type	String	网卡挂载的类型，比如normal，direct，baremetal。
created_at	String	网卡创建时间 (UTC ISO8601格式)。
description	String	用户描述。
device_id	sttring	使用该网卡的设备ID，比如一个虚机uuid。
device_owner	sting	使用该网卡的设备类型，比如network：DHCP。
extra_dhcp_opts	array	额外的dhcp参数列表。
fixed_ips	array	网卡的固定ip列表。
id	String	网卡的ID。
mac_address	String	网卡的mac地址。
name	satring	网卡的名称。
network_id	String	网卡所属的网络ID。
port_security_enabled	boolean	网卡的安全状态。true或者false，如果是true将会配置安全组规则和anti-spoofing规则，否则不会处理。
project_id	String	网卡所属的project id。
qos_policy_id	String	网卡关联的qos策略id。
revision_number		网卡的版本号。
security_groups	array	网卡关联的安全组列表。
status	String	网卡的状态： ACTIVE, DOWN, BUILD and ERROR。
tags	array	网卡的标签列表。
tenant_id	String	网卡所属的tenant id。
updated_at	String	网卡最近更新的时间(UTC ISO8601 格式)。

响应示例

{
    "port": {
        "admin_state_up": true,
        "allowed_address_pairs": [],
        "binding:host_id": "",
        "binding:profile": {},
        "binding:vif_details": {},
        "binding:vif_type": "unbound",
        "binding:vnic_type": "normal",
        "created_at": "2021-02-24T07:01:14Z",
        "description": "",
        "device_id": "",
        "device_owner": "",
        "extra_dhcp_opts": [],
        "fixed_ips": [
            {
                "ip_address": "172.16.0.14",
                "subnet_id": "95347c6c-181d-4739-998d-0365487c9ac6"
            }
        ],
        "id": "602debb5-289d-4ecc-bc86-6a2f84a4b677",
        "mac_address": "fa:16:3e:91:6b:15",
        "name": "test",
        "network_id": "1191a2fd-42c6-44b9-b153-3378407468f2",
        "port_security_enabled": true,
        "project_id": "8dac1bf1c3a24be18809f82e1f9a845d",
        "qos_policy_id": null,
        "revision_number": 5,
        "security_groups": [
            "65db6fc3-7ba5-42e9-95f1-d45145f1e65f"
        ],
        "status": "DOWN",
        "tenant_id": "8dac1bf1c3a24be18809f82e1f9a845d",
        "updated_at": "2021-02-24T07:01:15Z"
    }
}

正常响应代码

201

错误码

400，401，403，404，409，413

显示网卡详情

功能介绍

显示网卡详情。

URI

GET /v2.0/ports/{port_id}

请求消息

无

请求示例

示例：显示网卡
GET /v2.0/ports/01a9c14a-d4bb-4b28-a5c8-fd0458b8c94e

说明：
不需要指定body

响应消息

参数	参数类型	描述
port	object	网卡对象。
admin_state_up	boolean	网卡的admin状态，取值true或false。
allowed_address_pairs	array	网卡允许访问的地址pair列表，每个pair包含一个ip和mac。
binding:host_id	String	网卡所属的host id。
binding:profile	object	网卡信息字典，传递和接收用于后端网络插件处理的网卡信息。
binding:vif_details	object	网卡附加信息字典，目前主要字段是port_filter和ovs_hybrid_plug。
binding:vif_type	String	网卡绑定使用的ml2插件类型，比如ovs，bridge，macvtap，未绑定是unbound，失败是binding_failed。
binding:vnic_type	String	网卡挂载的类型，比如normal，direct，baremetal。
created_at	String	网卡创建时间 (UTC ISO8601格式).
description	String	用户描述。
device_id	sttring	使用该网卡的设备ID，比如一个虚机uuid。
device_owner	sting	使用该网卡的设备类型，比如network：DHCP。
extra_dhcp_opts	array	额外的dhcp参数列表。
fixed_ips	array	网卡的固定ip列表。
id	String	网卡的ID。
mac_address	String	网卡的mac地址。
name	satring	网卡的名称。
network_id	String	网卡所属的网络ID。
port_security_enabled	boolean	网卡的安全状态。true或者false，如果是true将会配置安全组规则和anti-spoofing规则，否则不会处理。
project_id	String	网卡所属的project id。
qos_policy_id	String	网卡关联的qos策略id。
revision_number		网卡的版本号。
security_groups	array	网卡关联的安全组列表。
status	String	网卡的状态： ACTIVE, DOWN, BUILD and ERROR。
tags	array	网卡的标签列表。
tenant_id	String	网卡所属的tenant id。
updated_at	String	网卡最近更新的时间(UTC ISO8601 格式)。

响应示例

{
 "port": {
       "admin_state_up": false,
       "allowed_address_pairs": [],
       "binding:host_id": "",
       "binding:profile": {},
       "binding:vif_details": {},
       "binding:vif_type": "unbound",
       "binding:vnic_type": "normal",
       "created_at": "2021-02-22T12:29:22Z",
       "description": "",
       "device_id": "",
       "device_owner": "",
       "extra_dhcp_opts": [],
       "fixed_ips": [
           {
            "ip_address": "172.16.0.9",
            "subnet_id": "c12ac01a-2422-473a-b297-baca99b2d690"
            }
        ],
        "id": "01a9c14a-d4bb-4b28-a5c8-fd0458b8c94e",
        "mac_address": "fa:16:3e:01:74:c7",
        "name": "kw-2_kw-test_1edaecca",
        "network_id": "328878f3-5805-42f1-82dd-40dcdd1f79f1",
        "port_security_enabled": true,
        "project_id": "8cd7d3e275584638964ff92ddd3b1596",
        "qos_policy_id": null,
        "revision_number": 5,
        "security_groups": [
            "dbd9b12d-1d79-4594-ba18-36967bc4b9ae"
        ],
        "status": "DOWN",
        "tenant_id": "8cd7d3e275584638964ff92ddd3b1596",
        "updated_at": "2021-02-22T12:29:22Z"
    }

正常响应代码

200

错误码

400，401，403，404，409，413

更新网卡

功能介绍

更新网卡。

URI

PUT /v2.0/ports/{port_id}

参数	是否必选	描述
port_id	是	网卡ID

请求消息

参数	参数类型	是否必选	描述
port	object	是	网卡对象。
admin_state_up	boolean	否	网卡的admin状态，取值true或false。
allowed_address_pairs	array	否	网卡允许访问的地址pair列表，每个pair包含一个ip和mac。
binding:host_id	String	否	网卡所属的host id。
binding:profile	object	否	网卡信息字典，传递和接收用于后端网络插件处理的网卡信息。
binding:vnic_type	String	否	网卡挂载的类型，比如normal，direct，baremetal，默认normal。
description	String	否	用户描述
device_id	sttring	否	使用该网卡的设备ID，比如一个虚机uuid
device_owner	String	否	使用该网卡的设备类型，比如network：DHCP。
extra_dhcp_opts	array	否	额外的dhcp参数列表。
fixed_ips	array	否	网卡的固定ip列表。
mac_address	String	否	网卡的mac地址。
name	satring	否	网卡的名称。
port_security_enabled	boolean	否	网卡的安全状态。true或者false，如果是true将会配置安全组规则和anti-spoofing规则，否则不会处理。
qos_policy_id	String	否	网卡关联的qos策略id。
security_groups	array	否	网卡关联的安全组列表。

请求示例

示例：更新网卡ip地址

PUT /v2.0/ports/602debb5-289d-4ecc-bc86-6a2f84a4b677
{
    "port": {
        "fixed_ips": [
            {
                "ip_address": "172.16.0.115",
                "subnet_id": "95347c6c-181d-4739-998d-0365487c9ac6"
            }
        ]
    }
}

响应消息

参数	参数类型	描述
port	object	网卡对象。
admin_state_up	boolean	网卡的admin状态，取值true或false。
allowed_address_pairs	array	网卡允许访问的地址pair列表，每个pair包含一个ip和mac。
binding:host_id	String	网卡所属的host id。
binding:profile	object	网卡信息字典，传递和接收用于后端网络插件处理的网卡信息。
binding:vif_details	object	网卡附加信息字典，目前主要字段是port_filter和ovs_hybrid_plug。
binding:vif_type	String	网卡绑定使用的ml2插件类型，比如ovs，bridge，macvtap，未绑定是unbound，失败是binding_failed。
binding:vnic_type	String	网卡挂载的类型，比如normal，direct，baremetal。
created_at	String	网卡创建时间 (UTC ISO8601格式)。
description	String	用户描述。
device_id	sttring	使用该网卡的设备ID，比如一个虚机uuid。
device_owner	sting	使用该网卡的设备类型，比如network：DHCP。
extra_dhcp_opts	array	额外的dhcp参数列表。
fixed_ips	array	网卡的固定ip列表。
id	String	网卡的ID。
mac_address	String	网卡的mac地址。
name	satring	网卡的名称。
network_id	String	网卡所属的网络ID。
port_security_enabled	boolean	网卡的安全状态。true或者false，如果是true将会配置安全组规则和anti-spoofing规则，否则不会处理。
project_id	String	网卡所属的project id。
qos_policy_id	String	网卡关联的qos策略id。
revision_number		网卡的版本号。
security_groups	array	网卡关联的安全组列表。
status	String	网卡的状态： ACTIVE, DOWN, BUILD and ERROR。
tags	array	网卡的标签列表。
tenant_id	String	网卡所属的tenant id。
updated_at	String	网卡最近更新的时间(UTC ISO8601 格式)。

响应示例

{
    "port": {
        "admin_state_up": true,
        "allowed_address_pairs": [],
        "binding:host_id": "",
        "binding:profile": {},
        "binding:vif_details": {},
        "binding:vif_type": "unbound",
        "binding:vnic_type": "normal",
        "created_at": "2021-02-24T07:01:14Z",
        "description": "",
        "device_id": "",
        "device_owner": "",
        "extra_dhcp_opts": [],
        "fixed_ips": [
            {
                "ip_address": "172.16.0.115",
                "subnet_id": "95347c6c-181d-4739-998d-0365487c9ac6"
            }
        ],
        "id": "602debb5-289d-4ecc-bc86-6a2f84a4b677",
        "mac_address": "fa:16:3e:91:6b:15",
        "name": "test",
        "network_id": "1191a2fd-42c6-44b9-b153-3378407468f2",
        "port_security_enabled": true,
        "project_id": "8dac1bf1c3a24be18809f82e1f9a845d",
        "qos_policy_id": null,
        "revision_number": 8,
        "security_groups": [
            "65db6fc3-7ba5-42e9-95f1-d45145f1e65f"
        ],
        "status": "DOWN",
        "tenant_id": "8dac1bf1c3a24be18809f82e1f9a845d",
        "updated_at": "2021-02-24T08:35:26Z"
    }
}

正常响应代码

200

错误码

400，401，403，404，409，413

删除网卡

功能介绍

删除指定网卡。

前提条件

网卡未被设备绑定。

URI

DELETE /v2.0/ports/{port_id}

参数	是否必选	描述
port_id	是	port的uuid

请求消息

无

请求示例

示例：删除网卡
DELETE /v2.0/ports/01a9c14a-d4bb-4b28-a5c8-fd0458b8c94e

说明：
不需要指定body。

响应消息

无

响应示例

无

正常响应代码

204

错误码

400，401，403，404，409，413