文档首页 > > API参考> API> 端口(废弃)> 更新端口(废弃)

更新端口(废弃)

分享
更新时间: 2019/08/31 18:43

功能介绍

更新端口

URI

PUT /v1/ports/{port_id}

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

名称

是否必选

说明

port_id

端口的唯一标识

请求消息

  • 请求参数
    表2 请求参数

    名称

    是否必选

    参数类型

    说明

    port

    Object

    端口对象,请参见表3

    表3 port字段说明

    名称

    是否必选

    参数类型

    说明

    name

    String

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

    security_groups

    Array of strings

    安全组的UUID

    allowed_address_pairs

    Array of allow_address_pair objects

    • 功能说明:IP/Mac对列表,allow_address_pair参见表4
    • 约束:
      • IP地址不允许为 “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(扩展属性),请参见表5

    表4 allow_address_pair对象

    名称

    参数类型

    说明

    ip_address

    String

    • 功能说明:IP地址
    • 约束:不支持0.0.0.0
    • 如果allowed_address_pairs配置地址池较大的CIDR(掩码小于24位),建议为该port配置一个单独的安全组。

    mac_address

    String

    MAC地址

    表5 extra_dhcp_opt对象

    名称

    是否必选

    参数类型

    说明

    opt_name

    String

    Option名称

    opt_value

    String

    Option值

  • 请求样例:
    {
        "port": {
            "name": "adc"
        }
    }

响应消息

  • 响应参数
    表6 响应参数

    名称

    参数类型

    说明

    port

    Object

    端口对象,请参见表7

    表7 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"}]
    • 约束:一个端口只支持一个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_pairobjects

    • 功能说明:IP/Mac对列表,allow_address_pair参见表9(扩展属性)。
    • 约束:IP地址不允许为 “0.0.0.0”
    • 如果allowed_address_pairs配置地址池较大的CIDR(掩码小于24位),建议为该port配置一个单独的安全组。

    extra_dhcp_opts

    Array of extra_dhcp_opt objects

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

    binding:vif_details

    Object

    vif的详细信息, "ovs_hybrid_plug": 是否为ovs/bridge混合模式

    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硬直通(不支持)

    port_security_enabled

    Boolean

    端口安全使能标记,如果不使能则安全组和dhcp防欺骗不生效,默认为true

    表8 fixed_ip对象

    名称

    参数类型

    说明

    subnet_id

    String

    • 功能说明:所属子网ID
    • 约束:不支持更新

    ip_address

    String

    端口IP地址

    表9 allow_address_pair对象

    名称

    参数类型

    说明

    ip_address

    String

    • 功能说明:IP地址
    • 约束:不支持0.0.0.0
    • 如果allowed_address_pairs配置地址池较大的CIDR(掩码小于24位),建议为该port配置一个单独的安全组。

    mac_address

    String

    MAC地址

    表10 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",
            "binding:vif_details": {},
            "binding:profile": {},
            "port_security_enabled":true
        }
    }

状态码

请参见状态码

错误码

请参考错误码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区