文档首页/ 虚拟私有云 VPC/ API参考 (巴黎区域) / API（OpenStack Neutron V2.0 原生）/ 端口/ 更新端口
更新时间：2024-03-05 GMT+08:00
查看PDF
分享

更新端口

功能介绍

更新端口。

URI

PUT /v2.0/ports/{port_id}

参数说明请参见表1。

表1 参数说明

名称

是否必选

说明

port_id

是

端口唯一标识

请求参数

表2 请求参数

参数名称

类型

必选

说明

port

port object

是

port对象，参见表3。

更新操作时至少指定一项属性。
表3 port对象

属性

是否必选

类型

说明

name

否

String

端口的名称

security_groups

否

Array of strings

扩展属性：安全组的UUID，例如："security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]

【使用说明】不支持更新为空。

allowed_address_pairs

否

Array of allowed_address_pairs objects

扩展属性：IP/Mac对列表，allow_address_pair参见表4

【使用说明】

  • IP地址不允许为 “0.0.0.0”
  • 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组
  • 如果allowed_address_pairs的IP地址为“1.1.1.1/0”，表示关闭源目地址检查开关
  • 硬件SDN环境不支持ip_address属性配置为CIDR格式
  • 为虚拟IP配置后端ECS场景，allowed_address_pairs中配置的IP地址，必须为ECS网卡已有的IP地址，否则可能会导致虚拟IP通信异常
  • 被绑定的云服务器网卡allowed_address_pairs的IP地址填“1.1.1.1/0”。

extra_dhcp_opts

否

Array of extra_dhcp_opt objects

扩展属性：DHCP的扩展Option，参见表5

binding:profile

否

Object

扩展属性：提供用户设置自定义信息

【使用说明】

  • internal_elb字段，布尔类型，普通租户可见。只有在创建内网ELB的虚拟IP的网卡时设置为true。普通租户没有权限更改该字段，由系统维护。

    举例：

    {"internal_elb": true}

  • disable_security_groups字段，布尔类型，普通租户可见。默认为false高性能通信场景下，允许指定为true普通租户可见。仅支持创建port和读取时指定。当前仅支持指定为true，不支持指定为false

    举例：

    {"disable_security_groups"：true }，

    当前仅支持指定为true，不支持指定为false，指定为true时，FWaaS功能不生效。

binding:vnic_type

否

String

绑定的vNIC类型

【使用说明】normal: 软交换
表4 allowed_address_pairs对象

名称

是否必选

参数类型

说明

ip_address

是

String
  • 功能说明：IP地址
  • 约束：不支持0.0.0.0/0
  • 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组。
  • 如果allowed_address_pairs的IP地址为“1.1.1.1/0”，表示关闭源目地址检查开关。
  • 被绑定的云服务器网卡allowed_address_pairs的IP地址填“1.1.1.1/0”。
  • 如果填写allowed_address_pairs参数，则ip_address是必选参数。

mac_address

否

String

MAC地址
表5 extra_dhcp_opt对象

属性

是否必选

类型

说明

opt_name

否

String

Option名称

opt_value

否

String

Option值

请求示例

更新id为7a9a954a-eb41-4954-a300-11ab17a361a2的端口，名称更新为port-test02。

PUT https://{Endpoint}/v2.0/ports/7a9a954a-eb41-4954-a300-11ab17a361a2 

{
    "port": {
           "name": "port-test02"
    }
}

响应参数

表6 响应参数

参数名称

类型

说明

port

port object

port对象，参见表7。
表7 port对象

属性

类型

说明

id

String

端口的ID，最大长度不超过255

【使用说明】在查询端口列表时非必选

name

String

端口的名称

network_id

String

所属网络的ID

admin_state_up

Boolean

管理状态

【使用说明】默认为true

mac_address

String

端口MAC地址，例如："mac_address": "fa:16:3e:9e:ff:55"

【使用说明】只支持系统动态分配，不支持指定

fixed_ips

Array of fixed_ip objects

端口IP，参见表8。例如："fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]，

"fixed_ips": [{"subnet_id": "1fd001aa-6946-4168-86d9-924c7d3ef8fb", "ip_address": "2a07:b980:4030:14::1"}]

device_id

String

设备ID

【使用说明】不支持设置和更新，由系统自动维护，该字段非空的端口不允许删除

device_owner

String

设备所属（DHCP/Router/ Nova等）

【取值范围】network:dhcp，network:router_interface_distributed，compute:xxx(xxx对应具体的可用区名称，例如compute:aa-bb-cc表示是被可用区aa-bb-cc上的ECS使用)，neutron:VIP_PORT，neutron:LOADBALANCERV2，neutron:LOADBALANCERV3，network:endpoint_interface，network:nat_gateway，network:ucmp

【使用说明】不支持更新，只允许用户在创建虚拟IP端口时，为虚拟IP端口设置device_owner为neutron:VIP_PORT，当端口的该字段不为空时，仅支持该字段为neutron:VIP_PORT时的端口删除。

该字段非空的端口不允许删除。

tenant_id

String

项目ID

status

String

端口状态，可以为ACTIVE，BUILD，DOWN；

【使用说明】Hana硬直通虚拟机端口状态总为DOWN

security_groups

Array of strings

扩展属性：安全组的UUID，例如："security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]

【使用说明】不支持更新为空。

allowed_address_pairs

Array of allowed_address_pairs objects

扩展属性：IP/Mac对列表，allow_address_pair参见表9

【使用说明】

  • IP地址不允许为 “0.0.0.0”
  • 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组
  • 如果allowed_address_pairs的IP地址为“1.1.1.1/0”，表示关闭源目地址检查开关
  • 硬件SDN环境不支持ip_address属性配置为CIDR格式
  • 为虚拟IP配置后端ECS场景，allowed_address_pairs中配置的IP地址，必须为ECS网卡已有的IP地址，否则可能会导致虚拟IP通信异常
  • 被绑定的云服务器网卡allowed_address_pairs的IP地址填“1.1.1.1/0”。

extra_dhcp_opts

Array of extra_dhcp_opt objects

扩展属性：DHCP的扩展Option，参见表10

binding:vif_details

binding:vif_details object

vif的详细信息，参见表11

binding:profile

Object

扩展属性：提供用户设置自定义信息

【使用说明】

  • internal_elb字段，布尔类型，普通租户可见。只有在创建内网ELB的虚拟IP的网卡时设置为true。普通租户没有权限更改该字段，由系统维护。

    举例：

    {"internal_elb": true}

  • disable_security_groups字段，布尔类型，普通租户可见。默认为false高性能通信场景下，允许指定为true普通租户可见。仅支持创建port和读取时指定。当前仅支持指定为true，不支持指定为false

    举例：

    {"disable_security_groups"：true }，

    当前仅支持指定为true，不支持指定为false，指定为true时，FWaaS功能不生效。

binding:vnic_type

String

绑定的vNIC类型

normal: 软交换

project_id

String

项目ID，请参见获取项目ID。

created_at

String

资源创建时间，UTC时间

格式yyyy-MM-ddTHH:mm:ss

updated_at

String

资源更新时间，UTC时间

格式yyyy-MM-ddTHH:mm:ss
表8 fixed_ip对象

属性

类型

说明

subnet_id

String

所属子网ID

【使用说明】不支持更新

ip_address

String

端口IP地址

【使用说明】不支持更新
表9 allowed_address_pairs对象

属性

类型

说明

ip_address

String

IP地址

【使用说明】不支持0.0.0.0

mac_address

String

MAC地址
表10 extra_dhcp_opt对象

属性

类型

说明

opt_name

String

Option名称

opt_value

String

Option值
表11 binding:vif_details对象

名称

参数类型

说明

primary_interface

Boolean

取值为true，表示是虚拟机的主网卡。

port_filter

Boolean

表示该网络服务提供端口过滤特性，如安全组和反MAC/IP欺骗。

ovs_hybrid_plug

Boolean

用于通知像nova这样的API消费者，应该使用OVS的混合插入策略。

响应示例

{
    "port": {
        "id": "a7d98f3c-b42f-460b-96a1-07601e145961",
        "name": "port-test02",
        "status": "DOWN",
        "admin_state_up": true,
        "fixed_ips": [],
        "mac_address": "fa:16:3e:01:f7:90",
        "network_id": "00ae08c5-f727-49ab-ad4b-b069398aa171",
        "tenant_id": "db82c9e1415a464ea68048baa8acc6b8",
        "project_id": "db82c9e1415a464ea68048baa8acc6b8",
        "device_id": "",
        "device_owner": "",
        "security_groups": [
            "d0d58aa9-cda9-414c-9c52-6c3daf8534e6"
        ],
        "extra_dhcp_opts": [],
        "allowed_address_pairs": [],
        "binding:vnic_type": "normal",
        "binding:vif_details": {},
        "binding:profile": {},
        "port_security_enabled": true,
        "created_at": "2018-09-20T01:45:26",
        "updated_at": "2018-09-20T01:48:56"
    }
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 端口