更新端口

功能介绍

更新端口

URI

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

请求消息

• 请求参数

  名称	是否必选	参数类型	说明
  port	是	Object	端口对象，请参见表2。

  表2 port字段说明

  名称	是否必选	参数类型	说明
  name	否	String	功能说明：端口名称 取值：默认为空，最大长度不超过255
  security_groups	否	Array of strings	扩展属性：安全组的UUID
  allowed_address_pairs	否	Array of allow_address_pair objects	功能说明：IP/Mac对列表，allow_address_pair参见表3。 约束： IP地址不允许为 “0.0.0.0/0” 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组。 为虚拟IP配置后端ECS场景，allowed_address_pairs中配置的IP地址，必须为ECS网卡已有的IP地址，否则可能会导致虚拟IP通信异常。
  extra_dhcp_opts	否	Array of extra_dhcp_opt objects	DHCP的扩展Option(扩展属性)，请参见表4。

  表3 allow_address_pair对象

  名称	是否必选	参数类型	说明
  ip_address	否	String	功能说明：IP地址 约束：不支持0.0.0.0/0 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组。
  mac_address	否	String	MAC地址

  表4 extra_dhcp_opt对象

  名称	是否必选	参数类型	说明
  opt_name	否	String	Option名称
  opt_value	否	String	Option值

• 请求样例

  PUT https://{Endpoint}/v1/{project_id}/ports/7204e0da-40de-4207-a536-6f59b84f6f0e
  
  {
      "port": {
          "name": "adc"
      }
  }

响应消息

• 响应参数

  表5 响应参数

  名称	参数类型	说明
  port	Object	端口对象，请参见表6。

  表6 port字段说明

  名称	参数类型	说明
  id	String	端口唯一标识
  name	String	功能说明：端口名称 取值：默认为空，最大长度不超过255
  network_id	String	功能说明：端口所属网络的ID 约束：必须是存在的网络ID
  admin_state_up	Boolean	功能说明：管理状态 约束：只支持true，默认为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"}]，请参见表9 约束：一个端口只支持一个fixed_ip，且不支持更新。
  device_id	String	功能说明：端口所属设备ID 约束：不支持设置和更新，由系统自动维护
  device_owner	String	功能说明：设备所属（DHCP/Router/ lb/Nova） 约束：不支持设置和更新，由系统自动维护
  tenant_id	String	项目ID。
  status	String	功能说明：端口状态，Hana硬直通虚拟机端口状态总为DOWN 取值范围：ACTIVE、BUILD、DOWN
  security_groups	Array of strings	安全组的UUID(扩展属性)
  allowed_address_pairs	Array of allow_address_pair objects	功能说明：IP/Mac对列表。请参见表10 约束：IP地址不允许为 “0.0.0.0/0” 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组。
  extra_dhcp_opts	Array of extra_dhcp_opt objects	DHCP的扩展Option(扩展属性)，请参见表11
  binding:vif_details	Object	功能说明：vif的详细信息， "ovs_hybrid_plug": 是否为ovs/bridge混合模式
  binding:profile	Object	功能说明：提供用户设置自定义信息(扩展属性)
  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防欺骗不生效

  表7 fixed_ip对象

  名称	参数类型	说明
  subnet_id	String	功能说明：所属子网ID 约束：不支持更新
  ip_address	String	端口IP地址

  表8 allow_address_pair对象

  名称	参数类型	说明
  ip_address	String	功能说明：IP地址 约束：不支持0.0.0.0/0 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组。
  mac_address	String	MAC地址

  表9 extra_dhcp_opt对象

  名称	参数类型	说明
  opt_name	String	Option名称
  opt_value	String	Option值

• 响应样例

  {
      "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"
      }
  }

状态码

请参见状态码。

错误码

请参考错误码。