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

更新弹性公网IP

功能介绍

更新弹性公网IP

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

最小长度:0

最大长度:32

publicip_id

String

弹性公网IP的ID

最小长度:0

最大长度:36

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

publicip

UpdatePublicipOption object

弹性公网IP对象

表3 UpdatePublicipOption

参数

是否必选

参数类型

描述

alias

String

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

最小长度:0

最大长度:64

description

String

  • 功能说明:公网IP的描述信息
  • 取值范围:0-256长度的字符串,不支持特殊字符<>

最小长度:0

最大长度:256

associate_instance_type

String

  • 功能说明:端口所属实例类型
  • 取值范围:
    • PORT
    • NATGW
    • VPN
    • ELB
  • 约束:
    • associate_instance_type和associate_instance_id都不为空时表示绑定实例
    • associate_instance_type和associate_instance_id都为null时解绑实例
    • 双栈公网IP不允许修改绑定的实例

最小长度:0

最大长度:36

枚举值:

  • PORT
  • NATGW
  • VPN
  • ELB

associate_instance_id

String

  • 功能说明:绑定的实例ID,例如ELB的实例ID,ECS的网卡ID
  • 约束:
    • associate_instance_type和associate_instance_id都不为空时表示绑定实例
    • associate_instance_type和associate_instance_id都为null时解绑实例
    • 双栈公网IP不允许修改绑定的实例

最小长度:0

最大长度:36

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

request_id

String

本次请求的编号

最小长度:0

最大长度:36

publicip

PublicipUpdateResp object

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

表5 PublicipUpdateResp

参数

参数类型

描述

id

String

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

最小长度:0

最大长度:36

project_id

String

  • 功能说明:项目ID

最小长度:0

最大长度:32

ip_version

Integer

  • 功能说明:IP版本信息
  • 取值范围:
    • 4:公网IP地址为public_ip_address地址
    • 6:公网IP地址为public_ipv6_address地址

枚举值:

  • 4
  • 6

public_ip_address

String

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

最小长度:0

最大长度:36

public_ipv6_address

String

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

最小长度:0

最大长度:64

status

String

  • 功能说明:弹性公网IP的状态
  • 取值范围:
    • FREEZED:冻结
    • BIND_ERROR:绑定失败
    • BINDING:绑定中
    • PENDING_DELETE:释放中
    • PENDING_CREATE:创建中
    • NOTIFYING:创建中
    • NOTIFY_DELETE:释放中
    • PENDING_UPDATE:更新中
    • DOWN:未绑定
    • ACTIVE:绑定
    • ELB:绑定ELB
    • VPN:绑定VPN
    • ERROR:失败

最小长度:0

最大长度:64

枚举值:

  • FREEZED
  • BIND_ERROR
  • BINDING
  • PENDING_DELETE
  • PENDING_CREATE
  • NOTIFYING
  • NOTIFY_DELETE
  • PENDING_UPDATE
  • DOWN
  • ACTIVE
  • ELB
  • ERROR
  • VPN

description

String

  • 功能说明:弹性公网IP描述信息
  • 约束:用户以自定义方式标识资源,系统不感知

最小长度:0

最大长度:256

public_border_group

String

  • 功能说明:表示中心站点资源或者边缘站点资源
  • 取值范围: center、边缘站点名称
  • 约束:publicip只能绑定该字段相同的资源

最小长度:1

最大长度:64

created_at

String

  • 功能说明:资源创建UTC时间
  • 格式:yyyy-MM-ddTHH:mm:ssZ

最小长度:0

最大长度:64

updated_at

String

  • 功能说明:资源更新UTC时间
  • 格式:yyyy-MM-ddTHH:mm:ssZ

最小长度:0

最大长度:64

type

String

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

最小长度:1

最大长度:36

枚举值:

  • 弹性公网IP
  • DUALSTACK

vnic

VnicInfo object

  • 功能说明:公网IP绑定实例有PORT时,PORT的相关信息
  • 约束:如果绑定的实例不依赖PORT,该对象为null

bandwidth

PublicipBandwidthInfo object

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

enterprise_project_id

String

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

最小长度:0

最大长度:36

billing_info

String

  • 功能说明:公网IP的订单信息
  • 约束:包周期才会有订单信息,按需资源此字段为空

最小长度:0

最大长度:256

lock_status

String

  • 功能说明:记录公网IP当前的冻结状态
  • 约束:metadata类型,标识欠费冻结、公安冻结
  • 取值范围:
    • police
    • locked

最小长度:0

最大长度:64

associate_instance_type

String

  • 功能说明:公网IP绑定的实例类型
  • 约束:ELBV1资源中国站已下线,目前仅存在国际站与和营云局点
  • 取值范围:
    • PORT
    • NATGW
    • ELB
    • ELBV1
    • VPN

最小长度:0

最大长度:64

枚举值:

  • PORT
  • NATGW
  • ELB
  • ELBV1
  • VPN

associate_instance_id

String

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

最小长度:0

最大长度:36

publicip_pool_id

String

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

最小长度:0

最大长度:36

publicip_pool_name

String

  • 功能说明:弹性公网IP的网络类型, 包括公共池类型,如5_bgp/5_sbgp...,和用户购买的专属池。
  • 专属池见publcip_pool相关接口

最小长度:0

最大长度:64

alias

String

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

最小长度:0

最大长度:64

associate_mode

String

  • 功能说明:开启支持直通模式后展示,表示直通模式的标识。(默认不显示)

最小长度:1

最大长度:36

表6 VnicInfo

参数

参数类型

描述

private_ip_address

String

  • 功能说明:私网IP地址

最小长度:0

最大长度:36

device_id

String

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

最小长度:0

最大长度:36

device_owner

String

  • 功能说明:设备所属
  • 取值范围:合法设备所属
    • network:dhcp
    • network:VIP_PORT
    • network:router_interface_distributed
    • network:router_centralized_snat
  • 约束:不支持设置和更新,由系统自动维护

最小长度:0

最大长度:64

vpc_id

String

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

最小长度:0

最大长度:36

port_id

String

  • 功能说明:端口ID

最小长度:0

最大长度:36

port_profile

String

  • 功能说明:端口profile信息

最小长度:0

最大长度:256

mac

String

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

最小长度:0

最大长度:64

vtep

String

  • 功能说明:VTEP IP

最小长度:0

最大长度:36

vni

String

  • 功能说明:VXLAN ID

最小长度:0

最大长度:36

instance_id

String

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

最小长度:0

最大长度:36

instance_type

String

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

最小长度:0

最大长度:36

表7 PublicipBandwidthInfo

参数

参数类型

描述

id

String

  • 功能描述:带宽ID

最小长度:0

最大长度:36

size

Integer

  • 功能描述:带宽大小
  • 取值范围:默认5Mbit/s~2000Mbit/s

最小值:0

最大值:99999

share_type

String

  • 功能说明:带宽类型,标识是否是共享带宽
  • 取值范围:
    • PER:独享带宽
    • WHOLE:共享带宽
  • 约束:其中IPv6暂不支持WHOLE类型带宽。

最小长度:0

最大长度:36

charge_mode

String

  • 功能说明:按流量计费还是按带宽计费
  • 取值范围:
    • bandwidth:按带宽计费
    • traffic:按流量计费
    • 95peak_plus:按增强型95计费

最小长度:0

最大长度:36

name

String

  • 功能说明:带宽名称
  • 取值范围:1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)

最小长度:0

最大长度:64

billing_info

String

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

最小长度:0

最大长度:256

请求示例

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

响应示例

状态码: 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操作正常返回

错误码

请参见错误码