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

批量创建弹性公网IP

功能介绍

批量创建弹性公网IP，本接口为异步接口，当前创建弹性公网IP请求下发成功后会返回job id，此时创建弹性公网IP并没有立即完成，需要通过调用查询job状态，当job状态为SUCCESS时代表批量创建弹性公网IP成功。

调试

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

URI

POST /v2/{project_id}/batchpublicips

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

bandwidth

是

BatchBandwidth object

带宽信息

publicip

是

BatchPublicIp object

弹性公网IP信息

publicip_number

是

Integer

  • 功能说明：批量创建弹性公网IP的个数

  • 取值范围：0~50

enterprise_project_id

否

String

  • 功能说明：企业项目ID。可以使用该字段过滤某个企业项目下的弹性公网IP。

  • 取值范围：最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。“0”表示默认企业项目。如果需要查询当前用户所有企业项目绑定的弹性公网IP，请传参all_granted_eps。
表3 BatchBandwidth

参数

是否必选

参数类型

描述

charge_mode

否

String

  • 功能说明：bandwidth（按带宽计费），traffic（按流量计费）。

  • 约束：不填或者为空时默认是bandwidth。

name

否

String

  • 功能说明：带宽名称

  • 取值范围：1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）

  • 约束：如果share_type是PER，该参数必须带，如果share_type是WHOLE并且id有值，该参数会忽略。

最小长度：1

最大长度：64

share_type

是

String

  • 功能说明：带宽类型

  • 取值范围：PER，WHOLE（PER为独占带宽，WHOLE是共享带宽）。其中IPv6暂不支持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

参数

是否必选

参数类型

描述

type

是

String

  • 功能说明：弹性公网IP的类型

  • 取值范围：5_bgp

  • 约束：

    • 必须是系统具体支持的类型。

    • publicip_id为IPv4端口，所以"type"字段未给定时，默认为5_bgp。

ip_version

否

Integer

  • 功能说明：IP版本信息

  • 取值范围：4和6，IPv6为开启NAT64能力

    • 4：IPv4

    • 6：IPv6

enterprise_project_id

否

String

  • 功能说明：企业项目ID。可以使用该字段过滤某个企业项目下的弹性公网IP。

  • 取值范围：最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。“0”表示默认企业项目。如果需要查询当前用户所有企业项目绑定的弹性公网IP，请传参all_granted_eps。

tags

否

Array of strings

  • 功能说明：标签列表

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

  • 标签的key约束

    • 长度不超过128个字符。

    • 由英文字母、数字、下划线、中划线、中文字符组成

    • 同一资源的key值不能重复。

  • 标签的value约束

    • 长度不超过255个字符。

    • 同一资源的key值不能重复。

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}

请求示例

批量创建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"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 批量操作弹性公网IP

相关文档