弹性公网IP EIP-申请EIP(按需计费):请求参数

时间:2023-12-01 14:24:56

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

bandwidth

CreatePublicipBandwidthOption object

带宽对象

enterprise_project_id

String

  • 企业项目ID。最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。

  • 创建弹性公网IP时,给弹性公网IP绑定企业项目ID。

  • 不指定该参数时,默认值是 0

关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理用户指南》

缺省值:0

最小长度:0

最大长度:36

publicip

CreatePublicipOption object

弹性公网IP对象

表3 CreatePublicipBandwidthOption

参数

是否必选

参数类型

描述

charge_mode

String

  • 功能说明:按流量计费还是按带宽计费。

  • 取值范围:bandwidth,traffic,不填或者为空时默认是bandwidth。其中IPv6国外默认是bandwidth,国内默认是traffic。

缺省值:bandwidth

枚举值:

  • bandwidth

  • traffic

id

String

  • 功能说明:带宽ID,创建WHOLE类型带宽的EIP时可以指定之前的共享带宽创建

  • 取值范围:WHOLE类型的带宽ID

最大长度:36

name

String

  • 功能说明:带宽名称

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

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

最小长度:1

最大长度:64

share_type

String

  • 功能说明:带宽类型

  • 取值范围:PER,WHOLE(PER为独占带宽,WHOLE是共享带宽)。

  • 约束:该字段为WHOLE时,必须指定带宽ID。

枚举值:

  • WHOLE

  • PER

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。

表4 CreatePublicipOption

参数

是否必选

参数类型

描述

ip_address

String

  • 功能说明:希望申请到的EIP的地址,不指定时由系统自动分配

  • 约束:必须为IPv4地址格式,且必须在可用地址池范围内

最大长度:15

type

String

  • 功能说明:EIP的类型

  • 取值范围:5_bgp(全动态BGP),5_sbgp(静态BGP),5_youxuanbgp(优选BGP)

    • 华南-广州:5_bgp、5_sbgp

    • 华东-上海一:5_bgp、5_sbgp

    • 华东-上海二:5_bgp、5_sbgp

    • 华北-北京一:5_bgp、5_sbgp

    • 中国-香港:5_bgp、5_youxuanbgp

    • 亚太-曼谷:5_bgp

    • 亚太-新加坡:5_bgp

    • 非洲-约翰内斯堡:5_bgp

    • 西南-贵阳一:5_sbgp

    • 华北-北京四:5_bgp、5_sbgp

    • 拉美-圣地亚哥:5_bgp

    • 拉美-圣保罗一:5_bgp

    • 拉美-墨西哥城一:5_bgp

    • 拉美-布宜诺斯艾利一:5_bgp

    • 拉美-利马一:5_bgp

    • 拉美-圣地亚哥二: 5_bgp

  • 约束:

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

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

ip_version

Integer

  • 功能说明:弹性公网IP的版本

  • 取值范围:4、6,ipv6表示开启NAT64能力

  • 约束:

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

    • 不填或空字符串时,默认创建ipv4

缺省值:4

枚举值:

  • 4

  • 6

alias

String

  • 功能说明:弹性公网IP名称

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

最大长度:64

port_id

String

  • 功能说明:端口id

  • 约束:必须是存在的端口id,如果该端口不存在或端口已绑定EIP则会提示出错。

最小长度:36

最大长度:36

support.huaweicloud.com/api-eip/eip_api_0001.html