创建弹性公网IP - CreatePublicIp

功能介绍

根据用户的请求内容，创建弹性公网IP

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

POST /v1/publicips

请求参数

表1 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

表2 请求Body参数
参数	是否必选	参数类型	描述
publicip	是	CreatePublicIpOption object	弹性公网IP的信息字典对象
bandwidth	否	CreatePublicIpBandwidthOption object	带宽参数。

表3 CreatePublicIpOption
参数	是否必选	参数类型	描述
site_id	是	String	边缘站点的ID。
ip_version	否	String	弹性公网IP的版本。目前IEC服务只支持4，即ipv4。
type	否	String	线路ID。不传时默认取当前站点第一条线路

表4 CreatePublicIpBandwidthOption
参数	是否必选	参数类型	描述
id	否	String	带宽id。开启创建带宽白名单后，需要填写该参数。
bandwidth_type	否	String	带宽类型。指定带宽ID，则该参数不生效。不指定带宽的情况下，如果当前带宽类型下没有带宽，自动在该带宽类型下创建带宽，有则使用最近创建的带宽。

响应参数

状态码：200

表5 响应Body参数
参数	参数类型	描述
publicip	PublicIp object	弹性公网ip数据。

表6 PublicIp
参数	参数类型	描述
id	String	弹性公网IP唯一标识。
status	String	弹性公网IP的状态。取值范围： FREEZED：冻结 BIND_ERROR：绑定失败 BINDING：绑定中 PENDING_DELETE：释放中 PENDING_CREATE：创建中 NOTIFYING：创建中 NOTIFY_DELETE：释放中 PENDING_UPDATE：更新中 DOWN：未绑定 ACTIVE：绑定 ELB：绑定ELB VPN：绑定VPN ERROR：失败
port_id	String	端口的ID。
public_ip_address	String	弹性公网IP的地址。
private_ip_address	String	绑定弹性公网IP的私有IP地址。
create_time	String	创建时间。
bandwidth_id	String	带宽的ID。
bandwidth_name	String	带宽的名称。
bandwidth_share_type	String	带宽的类型。取值范围： WHOLE：共享带宽
bandwidth_size	Integer	带宽的大小。
ip_version	Integer	IP版本的信息。
site_id	String	子网所属的站点ID。
site_info	String	子网所属的站点信息。
operator	Operator object	运营商信息。
type	String	弹性公网IP的类型。

表7 Operator
参数	参数类型	描述
id	String	运营商ID。
name	String	运营商名称。取值范围： chinamobile：中国移动； chinaunicom：中国联通； chinatelecom：中国电信。
i18n_name	String	运营商国际化名称。
sa	String	运营商的简写。

请求示例

在站点e3b52316-05be-11ea-bc35-286ed488d287创建ipv4的弹性公网IP

POST https://{endpoint}/v1/publicips

{
  "publicip" : {
    "site_id" : "e3b52316-05be-11ea-bc35-286ed488d287",
    "ip_version" : "4"
  }
}

响应示例

状态码：200

{
  "publicip" : {
    "id" : "8bdc72de-f35c-4ec6-8304-5ffee39f6054",
    "status" : "PENDING_CREATE",
    "type" : "5_sbgp_site1",
    "site_id" : "705da43d-fa20-11ea-9fb2-fa1640495574",
    "site_info" : "China/华中地区/湖南/长沙市",
    "public_ip_address" : "188.181.52.224",
    "create_time" : "2021-03-16 01:52:38",
    "bandwidth_size" : 0,
    "ip_version" : 4,
    "operator" : {
      "id" : "1",
      "i18n_name" : "中国电信",
      "sa" : "CTCC"
    }
  }
}