文档首页/弹性公网IP EIP/API参考/API/批量操作弹性公网IP/批量创建弹性公网IP
更新时间：2025-02-08 GMT+08:00
查看PDF
分享

批量创建弹性公网IP

功能介绍

批量创建弹性公网IP

URI

POST /v2/{project_id}/batchpublicips

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目id

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

bandwidth

是

BatchBandwidth object

带宽信息

publicip

是

BatchPublicIp object

弹性公网IP信息

publicip_number

是

Integer

批量创建EIP的个数

enterprise_project_id

是

String

企业项目id

表3 BatchBandwidth

参数

是否必选

参数类型

描述

charge_mode

否

String

  • 功能说明：按流量计费还是按带宽计费。其中IPv6国外默认是bandwidth，国内默认是traffic。取值为traffic，表示流量计费。

枚举值：

  • bandwidth
  • traffic

name

否

String

  • 功能说明：带宽名称
  • 取值范围：1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）
  • 约束：如果share_type是PER，该参数必须带,如果share_type是WHOLE并且id有值，该参数会忽略。

最小长度：1

最大长度：64

share_type

否

String

  • 功能说明：带宽类型
  • 取值范围：PER，WHOLE。其中IPv6暂不支持WHOLE类型带宽。

枚举值：

  • PER
  • WHOLE

size

是

Integer

  • 功能说明：带宽大小
  • 取值范围：默认1Mbit/s~2000Mbit/s（具体范围以各区域配置为准，请参见控制台对应页面显示）。
  • 约束：share_type是PER，该参数必须带，如果share_type是WHOLE并且id有值，该参数会忽略。
  • 注意：调整带宽时的最小单位会根据带宽范围不同存在差异。
    • 小于等于300Mbit/s：默认最小单位为1Mbit/s。
    • 300Mbit/s~1000Mbit/s：默认最小单位为50Mbit/s。
    • 大于1000Mbit/s：默认最小单位为500Mbit/s。

id

否

String

  • 功能说明：带宽ID，创建WHOLE类型带宽的弹性公网IP时可以指定之前的共享带宽创建
  • 取值范围：WHOLE类型的带宽ID
表4 BatchPublicIp

参数

是否必选

参数类型

描述

id

否

String

指定id创建EIP

type

是

String

公网ip类型

枚举值：

  • 5_bgp
  • 5_union
  • 5_sbgp

ip_version

否

String

公网EIP的版本，例如ipv4，ipv6，默认为ipv4

enterprise_project_id

否

String

企业项目id

tags

否

Array of ResourceTagOption objects

  • 功能说明：标签列表
  • 格式：标签的key与value中间以*号隔开，创建多个标签时，不同的key/value组以逗号,隔开，具体请见请求示例。

profile

否

BatchProfile object

订单信息

表5 ResourceTagOption

参数

是否必选

参数类型

描述

key

是

String

  • 功能说明：标签名称
  • 约束：
    • 不能为空。
    • 长度不超过128个字符。
    • 由英文字母、数字、下划线、中划线、中文字符组成
    • 同一资源的key值不能重复。

最大长度：128

value

是

String

  • 功能说明：标签值
  • 约束：
    • 长度不超过255个字符。
    • 由英文字母、数字、下划线、中划线、中文字符组成
    • 同一资源的key值不能重复。

最大长度：255

表6 BatchProfile

参数

是否必选

参数类型

描述

user_id

否

String

租户id

product_id

否

String

产品id

region_id

否

String

局点id

order_id

否

String

订单id

响应参数

状态码： 200

表7 响应Body参数

参数

参数类型

描述

job_id

String

job_id，需要访问调用netAPI组件访问job执行情况。netAPI：/v1/{project_id}/jobs/{job_id}

请求示例

批量创建2个弹性公网IP，带标签创建，带宽为按宽带计费、5M大小的独享带宽。

POST /v2/{project_id}/batchpublicips

{
  "bandwidth" : {
    "name" : "",
    "size" : 5,
    "charge_mode" : "bandwidth",
    "share_type" : "PER"
  },
  "publicip" : {
    "type" : "5_bgp",
    "tags" : ["name*tom", "type*kkkk"]
  },
  "publicip_number" : 2,
  "enterprise_project_id" : 0
}

响应示例

状态码： 200

OK

{
  "job_id" : "ff8080828436722c0184cdb88e9200a5"
}

状态码

请参见状态码。

错误码

请参见错误码。