创建弹性公网IP - CreatePublicIpV3

功能介绍

创建弹性公网IP。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，当前API调用无需身份策略权限。

URI

POST /v3/{project_id}/eip/publicips

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：项目ID。请参见获取项目ID 取值范围：不涉及最大长度：32

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
publicip	是	EIPAddDict object	弹性公网IP对象的创建请求体

表3 EIPAddDict
参数	是否必选	参数类型	描述
id	否	String	参数解释：公网IP的唯一标识。约束限制：UUID格式，管理员才能指定。最小长度：36 最大长度：36
ip_version	否	Integer	参数解释：IP版本信息。约束限制：必须是系统具体支持的类型。取值范围： 4：公网IP地址为public_ip_address地址。 6：公网IP地址为public_ipv6_address地址。最小值：4 最大值：6
alias	否	String	功能说明：公网IP的名称最小长度：0 最大长度：255
type	否	String	参数解释：弹性公网IP类型。约束限制：不涉及取值范围： EIP：IPV4类型的弹性公网IP。 DUALSTACK：IPV6类型的弹性公网IP。默认取值：不涉及
publicip_pool_name	是	String	参数解释：弹性公网IP的网络类型, 包括公共池类型，如5_bgp/5_sbgp...，和用户购买的专属池。专属池见publicip_pool相关接口
public_ip_address	否	String	参数解释：希望申请到的弹性IP弹性公网IP地址，不指定时由系统自动分配约束限制：必须为IPv4地址格式，且必须在可用地址池范围内最小长度：0 最大长度：64
public_ipv6_address	否	String	参数解释：IPv4时无此字段，IPv6时为申请到的弹性公网IP地址
description	否	String	参数解释：弹性公网IP描述信息约束限制：用户以自定义方式标识资源，系统不感知
enterprise_project_id	否	String	参数解释：企业项目ID。最大长度36字节,带“-”连字符的UUID格式，或者是字符串“0”。创建弹性公网IP时，给弹性公网IP绑定企业项目ID。
bandwidth	是	PublicipBandwidthInfo object	公网IP绑定的带宽信息
associate_instance_type	否	String	参数解释：公网IP绑定的实例类型，可以根据associate_instance_type字段过滤取值范围： PORT（云服务器实例类型，云服务器通常包括ECS、BMS、CCE等） NATGW（NAT网关实例类型） ELB（弹性负载均衡ELB实例类型） ELBV1（弹性负载均衡ELBV1实例类型，存量经典型ELBv1） VPN（虚拟专用网络VPN实例类型）
associate_instance_id	否	String	参数解释：绑定实例ID 约束限制：associate_instance_type和associate_instance_id都不为空时表示绑定实例； associate_instance_type和associate_instance_id都为null时解绑实例最小长度：0 最大长度：36
billing_info	否	String	功能说明：订单信息最小长度：0 最大长度：1024
cascade_delete_by_instance	否	Boolean	ecs调用时支持该字段如果为true，表示ecs删除时级联删除该eip 如果为false，表示ecs删除时级联不删除该eip 缺省值：false
associate_mode	否	String	参数解释：开启支持直通模式后展示，表示直通模式的标识。（默认不显示）最小长度：1 最大长度：36
lock_infos	否	Array of strings	公网IP当前的冻结状态

表4 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不为空，说明是包周期的带宽

响应参数

状态码：201

表5 响应Body参数
参数	参数类型	描述
publicip	PublicipResp object	弹性公网IP对象
request_id	String	本次请求编号

表6 PublicipResp
参数	参数类型	描述
id	String	功能说明：弹性公网IP的唯一标识
project_id	String	功能说明：项目ID
ip_version	Integer	功能说明: 弹性公网IP版本号取值范围: 4、6，6为开启NAT64能力 4表示公网IP地址为public_ip_address地址 6表示公网IP地址为public_ipv6_address地址
public_ip_address	String	功能说明: 弹性公网IPv4地址
public_ipv6_address	String	功能说明: 弹性公网IPv6地址
status	String	功能说明：弹性公网IP的状态取值范围：FREEZED，DOWN，ACTIVE，ERROR。 FREEZED表示弹性公网IP处于冻结状态 DOWN表示弹性公网IP未绑定实例 ACTIVE表示弹性公网IP绑定实例，正在使用中 ERROR表示弹性公网IP状态异常
description	String	功能说明：弹性公网IP的描述信息约束与限制：用户以自定义方式标识资源，系统不感知
created_at	String	功能说明：弹性公网IP的创建时间约束与限制：UTC时间格式（2018-12-25T10:07:24Z）
updated_at	String	功能说明：弹性公网IP最近的更新时间约束与限制：UTC时间格式（2018-12-25T10:09:20Z）
type	String	参数解释：弹性公网IP类型。约束限制：不涉及取值范围： EIP：IPV4类型的弹性公网IP。 DUALSTACK：IPV6类型的弹性公网IP。默认取值：不涉及
vnic	VnicResp object	功能说明：弹性公网IP绑定实例有PORT时，PORT的相关信息约束与限制：如果绑定的实例不依赖PORT，该对象为null
bandwidth	BandwidthResp object	功能说明：弹性公网IP绑定的带宽信息
enterprise_project_id	String	功能说明：弹性公网IP的企业项目ID
billing_info	String	功能说明：弹性公网IP的订单信息约束与限制：包周期才会有订单信息，按需资源此字段为空
lock_status	String	参数解释：弹性公网IP当前的冻结状态。约束限制：metadata类型取值范围： POLICE：公安冻结。 LOCKED：普通冻结。 ARREAR：普通冻结中的欠费冻结。 DELABLE：普通冻结中的可删除冻结。默认取值：不涉及
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...，和用户购买的专属池。专属池见publicip_pool相关接口
alias	String	功能说明：弹性公网IP别名
public_border_group	String	功能说明：中心还是边缘。中心CENTER，边缘为各边缘区域名称

表7 VnicResp
参数	参数类型	描述
private_ip_address	String	功能说明：PORT的内网地址
device_id	String	功能说明：端口所属设备ID，表示使用子网内私有IP地址的云服务资源ID，比如云服务器的ID、ELB的ID。约束与限制：存在PORT时，此字段associate_instance_id相同，都为实例ID
device_owner	String	功能说明：端口所属的设备，表示使用子网内私有IP地址的云服务资源。约束与限制：存在PORT时，此字段和associate_instance_type都可区分实例类型
vtep	String	功能说明：VTEP IP
vni	String	功能说明：VXLAN ID
vpc_id	String	功能说明：PORT所在VPC的ID
port_id	String	功能说明：PORT的唯一标识
port_profile	String	功能说明：端口profile信息
mac	String	功能说明：PORT的MAC信息
instance_id	String	功能说明：PORT的使用者，不同于device_id的归属者。举例：vip port的device_owner为vip，但是这个port实际使用者可能是虚机或其他
instance_type	String	功能说明：port的使用者。约束限制：不涉及取值范围： PORT：弹性网卡。 PEP_PORT：PEP弹性网卡。 EVPN：以太网虚拟私有网络。 NATGW：NAT网关。 P2CVPN：P2C虚拟专用网络。默认取值：不涉及
port_vif_details	String	功能说明：网卡虚拟接口的详细信息

表8 BandwidthResp
参数	参数类型	描述
id	String	功能说明：带宽ID
size	Integer	功能说明：带宽大小
share_type	String	功能说明：类型 “WHOLE”为共享带宽，“PER”为独占带宽
charge_mode	String	功能说明：带宽计费模式
name	String	功能说明：带宽名称
billing_info	String	功能说明：带宽的订单信息

请求示例

创建独享带宽的IPv4弹性公网IP。

POST https://{Endpoint}/v3/{project_id}/eip/publicips

{
  "publicip" : {
    "type" : "EIP",
    "publicip_pool_name" : "5_telcom",
    "bandwidth" : {
      "size" : 300,
      "share_type" : "PER",
      "charge_mode" : "bandwidth",
      "name" : "bandwidth-b556"
    }
  }
}

响应示例

状态码：201

正常创建

{
  "publicip" : {
    "id" : "0c464dad-86f3-4953-8bd4-c22bb0eb0bde",
    "project_id" : "b2782e6708b8475c993e6064bc456bf8",
    "alias" : "test eip",
    "ip_version" : 4,
    "public_ip_address" : "100.64.0.253",
    "publicip_pool_name" : "5_telcom",
    "status" : "ACTIVE",
    "description" : "description test",
    "created_at" : "2018-12-25T10:07:24Z",
    "updated_at" : "2018-12-25T10:07:24Z",
    "type" : "EIP",
    "vnic" : {
      "private_ip_address" : "172.16.1.75",
      "device_id" : "b61769a5-f8c4-448f-ae5b-2cbe1baa20ca",
      "device_owner" : "compute:AZ1",
      "vpc_id" : "1314cd0b-5dea-4697-b45a-a2304ff87e9c",
      "port_id" : "b01795fc-a246-4e4c-b770-0e4d58101592",
      "mac" : "fa:16:3e:ac:a8:0b"
    },
    "bandwidth" : {
      "id" : "b01795fc-a246-4e4c-b770-0e4d58101592",
      "size" : 300,
      "share_type" : "PER",
      "charge_mode" : "traffic",
      "name" : "bandwidth-b556"
    },
    "enterprise_project_id" : "b261ac1f-2489-4bc7-b31b-c33c3346a439",
    "associate_instance_type" : "PORT",
    "associate_instance_id" : "b61769a5-f8c4-448f-ae5b-2cbe1baa20ca",
    "public_border_group" : "CENTER"
  },
  "request_id" : "4a06c169-cc67-4d94-a786-2d70ef09b100"
}