更新时间:2023-12-25 GMT+08:00

批量创建弹性公网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 strings

公网EIP标签

profile

BatchProfile object

订单信息

表5 BatchProfile

参数

是否必选

参数类型

描述

user_id

String

租户id

product_id

String

产品id

region_id

String

局点id

order_id

String

订单id

响应参数

状态码: 200

表6 响应Body参数

参数

参数类型

描述

job_id

String

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

请求示例

POST /v2/{project_id}/batchpublicips

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

响应示例

状态码: 200

OK

{
  "job_id" : "ff8080828436722c0184cdb88e9200a5"
}

状态码

请参见状态码

错误码

请参见错误码