更新时间:2024-04-15 GMT+08:00

更新端口

功能介绍

更新端口。

URI

PUT /v1/{project_id}/ports/{port_id}

参数说明请参见表1
表1 参数说明

名称

是否必选

说明

port_id

端口的唯一标识。

project_id

项目ID,请参见获取项目ID

请求参数

名称

是否必选

参数类型

说明

port

port object

端口对象,请参见表2

表2 port字段说明

名称

是否必选

参数类型

说明

name

String

  • 功能说明:端口名称。
  • 取值范围:默认为空,最大长度不超过255。

security_groups

Array of strings

扩展属性:安全组的UUID。

allowed_address_pairs

Array of allowed_address_pairs objects

  • 功能说明:IP/Mac对列表,allow_address_pair参见表3
  • 约束:
    • IP地址不允许为 “0.0.0.0/0”。
    • 如果allowed_address_pairs配置地址池较大的CIDR(掩码小于24位),建议为该port配置一个单独的安全组。
    • 如果allowed_address_pairs的IP地址为“1.1.1.1/0”,表示关闭源目地址检查开关。
    • 为虚拟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(扩展属性),请参见表4

表3 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地址。

表4 extra_dhcp_opt对象

名称

是否必选

参数类型

说明

opt_name

String

DHCP选项名称,目前仅支持填写“51”,表示DHCP租约时间。

opt_value

String

DHCP选项的值。

当“opt_name”为“51”时,参数格式为“Xh”,表示DHCP租约时间为X小时。

“X”的取值范围为1~30000或“-1”,“-1”表示DHCP租约时间无限长。

请求示例

  • 更新id为7204e0da-40de-4207-a536-6f59b84f6f0e的端口,名称更新为abc。
    PUT https://{Endpoint}/v1/{project_id}/ports/7204e0da-40de-4207-a536-6f59b84f6f0e
     
    {
        "port": {
            "name": "adc"
        }
    }

响应参数

表5 响应参数

名称

参数类型

说明

port

port object

端口对象,请参见表6

表6 port字段说明

名称

参数类型

说明

id

String

端口唯一标识。

name

String

  • 功能说明:端口名称。
  • 取值:默认为空,最大长度不超过255。

network_id

String

  • 功能说明:端口所属网络的ID。
  • 约束:必须是存在的网络ID。

admin_state_up

Boolean

  • 功能说明:管理状态。
  • 约束:默认为true。

mac_address

String

  • 功能说明:端口MAC地址。
  • 约束:由系统分配,不支持指定。

fixed_ips

Array of fixed_ip objects

  • 功能说明:端口IP。例如:"fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}],请参见表7
  • 约束:ipv4场景下,一个端口只支持一个fixed_ip,且不支持更新。ipv6场景下,一个端口最多可以支持两个fixed_ip,且不支持更新。

device_id

String

  • 功能说明:端口所属设备ID。
  • 约束:不支持设置和更新,由系统自动维护。

device_owner

String

  • 功能说明:设备所属(DHCP/Router/ lb/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

  • 功能说明:端口状态,Hana硬直通虚拟机端口状态总为DOWN。
  • 取值范围:ACTIVE、BUILD、DOWN。

security_groups

Array of strings

安全组的UUID(扩展属性)。

allowed_address_pairs

Array of allowed_address_pairs objects

  • 功能说明:IP/Mac对列表,请参见表8
  • 约束: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”。

extra_dhcp_opts

Array of extra_dhcp_opt objects

DHCP的扩展Option(扩展属性),请参见表9

binding:vif_details

binding:vif_details object

vif的详细信息,参见表10

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或者direct。
  • normal: 软交换direct: SRIOV硬直通(不支持)。

instance_id

String

  • 功能说明:端口所属实例ID,例如RDS实例ID。
  • 约束:不支持设置和更新,由系统自动维护。

instance_type

String

  • 功能说明:端口所属实例类型,例如“RDS”。
  • 约束:不支持设置和更新,由系统自动维护。

port_security_enabled

Boolean

  • 功能说明:端口安全使能标记,如果不使能则安全组和dhcp防欺骗不生效。

ipv6_bandwidth_id

String

  • 功能说明:IPv6网卡绑定的共享带宽ID。
  • 约束:只有IPv6网卡绑定了共享带宽,才会显示此参数。
表7 fixed_ip对象

名称

参数类型

说明

subnet_id

String

  • 功能说明:所属子网ID。

    如果您使用管理控制台,此值即为子网详情中的“IPv4子网ID”或“IPv6子网ID”参数值。

  • 约束:不支持更新。

ip_address

String

端口IP地址。

表8 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”。

mac_address

String

MAC地址。

表9 extra_dhcp_opt对象

名称

参数类型

说明

opt_name

String

DHCP选项名称,目前仅支持填写“51”,表示DHCP租约时间。

opt_value

String

DHCP选项的值。

当“opt_name”为“51”时,参数格式为“Xh”,表示DHCP租约时间为X小时。

“X”的取值范围为1~30000或“-1”,“-1”表示DHCP租约时间无限长。

表10 binding:vif_details对象

名称

参数类型

说明

primary_interface

Boolean

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

port_filter

Boolean

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

ovs_hybrid_plug

Boolean

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

响应示例

{
    "port": {
        "id": "7204e0da-40de-4207-a536-6f59b84f6f0e",
        "name": "adc",
        "status": "DOWN",
        "admin_state_up": "true",
        "fixed_ips": [
            {
                "subnet_id": "689156ca-038f-4478-b265-fd26aa8bbe31",
                "ip_address": "192.168.0.9"
            }
        ],
        "mac_address": "fa:16:3e:d7:f2:6c",
        "network_id": "b4152e98-e3af-4e49-bb7f-7766e2b5ec63",
        "tenant_id": "caa6cf4337ea47fb823b15709ebe8591",
        "device_id": "",
        "device_owner": "",
        "security_groups": [
            "59b39002-e79b-4bac-8e27-aa884ab1beb6"
        ],
        "extra_dhcp_opts": [],
        "allowed_address_pairs": [],
        "binding:vnic_type": "normal"
    }
}

状态码

请参见状态码

错误码

请参考错误码