文档首页/ 弹性公网IP EIP/ API参考/ API V3/ 弹性公网IP/ 更新弹性公网IP
更新时间：2025-10-21 GMT+08:00
在线调试
CLI示例
查看PDF
分享

更新弹性公网IP

功能介绍

更新弹性公网IP

URI

PUT /v3/{project_id}/eip/publicips/{publicip_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

最大长度：32

publicip_id

是

String

弹性公网IP的ID

最小长度：36

最大长度：36

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

publicip

是

UpdatePublicipOption object

弹性公网IP对象
表3 UpdatePublicipOption

参数

是否必选

参数类型

描述

alias

否

String

  • 功能说明：公网IP的名称。

最小长度：0

最大长度：64

description

否

String

  • 功能说明：公网IP的描述信息

  • 取值范围：0-255长度的字符串，不支持特殊字符<>

最小长度：0

最大长度：255

associate_instance_type

否

String

  • 功能说明：EIP绑定的实例类型

  • 取值范围：

    • PORT（云服务器实例类型，云服务器通常包括ECS、BMS、CCE等）

    • NATGW（NAT网关实例类型）

    • ELB（弹性负载均衡ELB实例类型）

    • ELBV1（弹性负载均衡ELBV1实例类型）

    • VPN（虚拟专用网络VPN实例类型）

  • 约束：

    • associate_instance_type和associate_instance_id都不为空时表示绑定实例

    • associate_instance_type和associate_instance_id都为null时表示解绑实例，通过APIE调用需要切换为文本输入方式输入null值，可参考解绑请求实例

    • 双栈公网IP不允许修改绑定的实例

最小长度：0

最大长度：36

associate_instance_id

否

String

  • 功能说明：绑定的实例ID，例如ELB的实例ID，ECS的网卡ID

  • 约束：

    • associate_instance_type和associate_instance_id都不为空时表示绑定实例

    • associate_instance_type和associate_instance_id都为null时表示解绑实例，通过APIE调用需要切换为文本输入方式输入null值，可参考解绑请求实例

    • 双栈公网IP不允许修改绑定的实例

最小长度：0

最大长度：36

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

request_id

String

本次请求的编号

publicip

PublicipUpdateResp object

更新弹性公网IP的返回对象
表5 PublicipUpdateResp

参数

参数类型

描述

id

String

  • 功能说明：弹性公网IP唯一标识

project_id

String

  • 功能说明：项目ID

ip_version

Integer

  • 功能说明：IP版本信息

  • 取值范围：

    • 4：公网IP地址为public_ip_address地址

    • 6：公网IP地址为public_ipv6_address地址

public_ip_address

String

  • 功能说明：弹性公网IP或者IPv6端口的地址

public_ipv6_address

String

  • 功能说明：IPv4时无此字段，IPv6时为申请到的弹性公网IP地址

status

String

  • 功能说明：弹性公网IP的状态

  • 取值范围：

    • FREEZED：冻结

    • BIND_ERROR：绑定失败

    • BINDING：绑定中

    • PENDING_DELETE：释放中

    • PENDING_CREATE：创建中

    • NOTIFYING：创建中

    • NOTIFY_DELETE：释放中

    • PENDING_UPDATE：更新中

    • DOWN：未绑定

    • ACTIVE：绑定

    • ELB：绑定ELB

    • VPN：绑定VPN

    • ERROR：失败

description

String

  • 功能说明：弹性公网IP描述信息

  • 约束：用户以自定义方式标识资源，系统不感知

public_border_group

String

  • 功能说明：表示中心站点资源或者边缘站点资源

  • 取值范围： center、边缘站点名称

  • 约束：publicip只能绑定该字段相同的资源

created_at

String

  • 功能说明：资源创建UTC时间

  • 格式：yyyy-MM-ddTHH:mm:ssZ

updated_at

String

  • 功能说明：资源更新UTC时间

  • 格式：yyyy-MM-ddTHH:mm:ssZ

type

String

功能说明：弹性公网IP类型

vnic

VnicInfo object

  • 功能说明：公网IP绑定实例有PORT时，PORT的相关信息

  • 约束：如果绑定的实例不依赖PORT，该对象为null

bandwidth

PublicipBandwidthInfo object

功能说明：公网IP绑定带宽信息

enterprise_project_id

String

功能说明：企业项目ID。最大长度36字节,带“-”连字符的UUID格式，或者是字符串“0”。创建弹性公网IP时，给弹性公网IP绑定企业项目ID

billing_info

String

  • 功能说明：公网IP的订单信息

  • 约束：包周期才会有订单信息，按需资源此字段为空

lock_status

String

  • 功能说明：记录公网IP当前的冻结状态

  • 约束：metadata类型，标识欠费冻结、公安冻结

  • 取值范围：

    • police

    • locked

associate_instance_type

String

  • 功能说明：公网IP绑定的实例类型

  • 取值范围：

    • PORT（云服务器实例类型，云服务器通常包括ECS、BMS、CCE等）

    • NATGW（NAT网关实例类型）

    • ELB（弹性负载均衡ELB实例类型）

    • VPN（虚拟专用网络VPN实例类型）

associate_instance_id

String

功能说明：公网IP绑定的实例ID

publicip_pool_id

String

功能说明：公网IP所属网络的ID。publicip_pool_name对应的网络ID

publicip_pool_name

String

  • 功能说明：弹性公网IP的网络类型, 包括公共池类型，如5_bgp/5_sbgp...，和用户购买的专属池。

  • 专属池见publcip_pool相关接口

alias

String

  • 功能说明：弹性公网IP名称

associate_mode

String

  • 功能说明：开启支持直通模式后展示，表示直通模式的标识。（默认不显示）
表6 VnicInfo

参数

参数类型

描述

private_ip_address

String

  • 功能说明：私网IP地址

device_id

String

  • 功能说明：端口所属设备ID，表示使用子网内私有IP地址的云服务资源ID，比如云服务器的ID、ELB的ID。

  • 约束：不支持设置和更新，由系统自动维护

device_owner

String

  • 功能说明：端口所属的设备，表示使用子网内私有IP地址的云服务资源。

  • 取值范围：合法设备所属

    • network:dhcp（表示DHCP服务）

    • network:VIP_PORT（表示创建的是虚拟IP）

    • network:router_interface_distributed（表示子网网关地址）

    • network:router_centralized_snat（表示SNAT网关地址）

  • 约束：不支持设置和更新，由系统自动维护

vpc_id

String

  • 功能说明：虚拟私有云ID

port_id

String

  • 功能说明：端口ID

port_profile

String

  • 功能说明：端口profile信息

mac

String

  • 功能说明：端口MAC地址

  • 约束：由系统分配，不支持指定

vtep

String

  • 功能说明：VTEP IP

vni

String

  • 功能说明：VXLAN ID

instance_id

String

  • 功能说明：端口所属实例ID，例如RDS实例ID

  • 约束：不支持设置和更新，由系统自动维护

instance_type

String

  • 功能说明：端口所属实例类型，例如“RDS”

  • 约束：不支持设置和更新，由系统自动维护

port_vif_details

String

  • 功能说明：网卡虚拟接口的详细信息
表7 PublicipBandwidthInfo

参数

参数类型

描述

id

String

  • 功能描述：带宽ID

size

Integer

  • 功能描述：带宽大小

  • 取值范围：默认5Mbit/s~2000Mbit/s

share_type

String

  • 功能说明：带宽类型，标识是否是共享带宽

  • 取值范围：

    • PER：独享带宽

    • WHOLE：共享带宽

  • 约束：其中IPv6暂不支持WHOLE类型带宽。

charge_mode

String

  • 功能说明：按流量计费还是按带宽计费

  • 取值范围：

    • bandwidth：按带宽计费

    • traffic：按流量计费

    • 95peak_plus：按增强型95计费

name

String

  • 功能说明：带宽名称

  • 取值范围：1-64个字符，支持数字、字母、中文、_（下划线）、-（中划线）、.（点）

billing_info

String

  • 功能说明：账单信息。如果billinginfo不为空，说明是包周期的带宽

请求示例

  • 更新弹性公网IP别名及描述示例

    {
  "publicip" : {
    "alias" : "abcd",
    "description" : "test!!!!"
  }
}

  • 弹性公网IP解绑实例请求示例

    {
  "publicip" : {
    "associate_instance_type" : null,
    "associate_instance_id" : null
  }
}

响应示例

状态码：200

PUT操作正常返回

{
  "publicip" : {
    "alias" : "abcd",
    "associate_instance_id" : null,
    "associate_instance_type" : null,
    "bandwidth" : {
      "billing_info" : "xxxx:xxxx:xxxx",
      "charge_mode" : "bandwidth",
      "id" : "80549ae1-cf7a-4f39-a45f-bdb8e194a1f4",
      "name" : "bandwidth-bd25-test",
      "share_type" : "WHOLE",
      "size" : 7
    },
    "billing_info" : null,
    "created_at" : "2020-06-18T14:05:32Z",
    "description" : "test!!!!",
    "enterprise_project_id" : "0",
    "public_border_group" : "center",
    "id" : "b0c42aa6-3d1d-4b39-9188-35ee6aa8d6f7",
    "ip_version" : 4,
    "lock_status" : null,
    "project_id" : "060576782980d5762f9ec014dd2f1148",
    "public_ip_address" : "xx.xx.xx.xx",
    "public_ipv6_address" : null,
    "publicip_pool_id" : "160576782980d5762f9ec014dd2f1148",
    "publicip_pool_name" : "5_mobile",
    "status" : "DOWN",
    "type" : "弹性公网IP",
    "updated_at" : "2020-06-18T14:05:32Z",
    "vnic" : null
  },
  "request_id" : "ead9f912bd1191e3d5f0037141098d91"
}

状态码

状态码

描述

200

PUT操作正常返回

错误码

请参见错误码。

父主题： 弹性公网IP