文档首页 > > API参考> API> 弹性公网IP> 申请包周期弹性公网IP

申请包周期弹性公网IP

分享
更新时间: 2019/12/25 GMT+08:00

功能介绍

申请包年包月的弹性公网IP。

在成功调用本接口申请包年包月的弹性公网IP后:

URI

POST /v2.0/{project_id}/publicips

参数说明请参见 表1
表1 参数说明

名称

是否必选

说明

project_id

项目ID

请求参数

  • 请求参数
    表2 请求参数

    名称

    是否必选

    参数类型

    说明

    publicip

    Object

    弹性公网IP对象,请参见表3

    bandwidth

    Object

    带宽对象,请参见表4

    extendParam

    Object

    扩展参数,用于包周期资源申请。请参见表5

    表3 publicip字段说明

    名称

    是否必选

    参数类型

    说明

    type

    String

    • 功能说明:弹性公网IP的类型
    • 取值范围:5_telcom(电信),5_union(联通),5_bgp(全动态BGP),5_sbgp(静态BGP)
      • 东北-大连:5_telcom、5_union
      • 华南-广州:5_bgp、5_sbgp
      • 华东-上海二:5_bgp、5_sbgp
      • 华北-北京一:5_bgp、5_sbgp
      • 亚太-香港:5_bgp
      • 亚太-曼谷:5_bgp
      • 亚太-新加坡:5_bgp
      • 非洲-约翰内斯堡:5_bgp
      • 西南-贵阳一:5_sbgp
      • 华北-北京四:5_bgp、5_sbgp
    • 约束:
      • 必须是系统具体支持的类型
      • publicip_id为IPv4端口,所以"publicip_type"字段未给定时,默认为5_bgp。
    • 约束:
      • 必须是系统具体支持的类型
      • publicip_id为IPv4端口,所以"publicip_type"字段未给定时,默认为5_bgp。

    ip_version

    Integer

    • 功能说明:弹性公网IP的版本
    • 取值范围:4、6,分别表示创建ipv4和ipv6
    • 约束:
      • 必须是系统具体支持的类型
      • 不填或空字符串时,默认创建ipv4
    表4 bandwidth字段说明

    名称

    是否必选

    参数类型

    说明

    name

    String

    • 功能说明:带宽名称
    • 取值范围:1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)
    • 约束:
      • 如果share_type是PER,该字段是必选。
      • 如果bandwidth对象的id有值,该字段被忽略。

    size

    Integer

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

    id

    String

    • 功能说明:使用已有的共享带宽创建IP
    • 取值范围:共享带宽ID
    • 约束:
      • WHOLE类型的带宽ID;
      • 在预付费的情况下,不填该值。该字段取空字符串时,会被忽略。

    share_type

    String

    • 功能说明:带宽类型
    • 取值范围:
      • PER:独享带宽
      • WHOLE:共享带宽
    • 使用已有带宽创建IP时,该字段的值,以带宽的共享类型为准。
    • 约束:在预付费的情况下,只能使用PER类型

    charge_mode

    String

    • 功能说明:计费模式,按流量计费或者按带宽计费。
    • 取值范围:bandwidth,traffic,默认是bandwidth。取值为traffic,表示流量计费。
    表5 extendParam字段说明

    名称

    是否必选

    参数类型

    说明

    charge_mode

    String

    • 功能说明:付费方式(预付费、按需付费;预付费,即包周期付费)
    • 取值范围:
      • prePaid -预付费,即包年包月;
      • postPaid -后付费,即按需付费;
      • 默认值是postPaid。
    • 后付费的场景下,extendParam的其他字段都会被忽略。

    period_type

    String

    • 功能说明:订购资源的周期类型(包年、包月等)。
    • 取值范围:
      • month-月
      • year-年
    • 约束:

      如果用包周期共享带宽创建时(即携带共享带宽id创建弹性公网IP)此字段可不填。付费方式是预付费且不是使用共享带宽创建IP时,该字段必选;

    使用共享带宽创建IP时,带宽资源到期时间与IP的到期时间相同。

    period_num

    Integer

    • 功能说明:订购周期数
    • 取值范围:(后续会随运营策略变化)
      • period_type为month时,为[1,9],
      • period_type为year时,为[1,1]
    • 约束:同period_type约束。

    is_auto_renew

    String

    • 功能说明:是否自动续订
    • 取值范围:

      false:不自动续订;true:自动续订;默认值:false

    • 约束:

      到期后,默认自动续订1个月(自动续订时间后续可能会变化),详情可联系客服咨询。

    is_auto_pay

    String

    • 功能说明:下单订购后,是否自动从客户的账户中支付;默认是“不自动支付”
    • 取值范围:
      • true:是(自动支付,从账户余额自动扣费)
      • false:否(默认值,只提交订单不支付,需要客户手动去支付)
    • 约束:

      自动支付时,只能使用账户的现金支付;如果要使用代金券,请选择不自动支付,然后在用户费用中心,选择代金券支付。

  • 请求样例1

    创建包周期独占带宽和弹性公网IP,大小1Mbit/s,周期1个月。不自动续费,不自动扣费。

    POST https://{Endpoint}/v2.0/{project_id}/publicips
    
    {
        "publicip": {
            "type": "5_bgp"
        },
        "bandwidth": {
            "name": "bw_666",
            "size": 1,
            "share_type": "PER",
            "charge_mode": "bandwidth"
        },
        "extendParam": {
            "charge_mode": "prePaid",
            "period_type": "month",
            "period_num": 1,
            "is_auto_renew": "false",
            "is_auto_pay": "true"
        }
    }
  • 请求样例2

    创建按需的IP、带宽;extendParam扩展字段,不填即可。

    POST https://{Endpoint}/v2.0/{project_id}/publicips
    
    {
        "publicip": {
            "type": "5_bgp"
        },
        "bandwidth": {
            "name": "bw_666",
            "size": 1,
            "share_type": "PER",
            "charge_mode": "bandwidth"
        }
    }

响应消息

  • 响应参数

    名称

    参数类型

    说明

    publicip

    Object

    弹性公网IP对象(后付费场景返回对象)

    order_id

    String

    订单号(预付费场景返回该字段)

    说明:

    表6 publicip字段说明

    名称

    参数类型

    说明

    id

    String

    弹性公网IP唯一标识

    status

    String

    • 功能说明:弹性公网IP的状态
    • 取值范围:
      • FREEZED:冻结
      • BIND_ERROR:绑定失败
      • BINDING:绑定中
      • PENDING_DELETE:释放中
      • PENDING_CREATE:创建中
      • PENDING_UPDATE:更新中
      • DOWN:未绑定
      • ACTIVE:绑定
      • ELB:绑定ELB
      • ERROR:异常失败

    publicip_type

    String

    • 功能说明:弹性公网IP的类型
    • 取值范围:5_telcom(电信),5_union(联通),5_bgp(全动态BGP),5_sbgp(静态BGP)
      • 东北-大连:5_telcom、5_union
      • 华南-广州:5_bgp、5_sbgp
      • 华东-上海二:5_bgp、5_sbgp
      • 华北-北京一:5_bgp、5_sbgp
      • 亚太-香港:5_bgp
      • 亚太-曼谷:5_bgp
      • 亚太-新加坡:5_bgp
      • 非洲-约翰内斯堡:5_bgp
      • 西南-贵阳一:5_sbgp
      • 华北-北京四:5_bgp、5_sbgp
    • 约束:
      • 必须是系统具体支持的类型
      • publicip_id为IPv4端口,所以"publicip_type"字段未给定时,默认为5_bgp。

    public_ip_address

    String

    IPv4时是申请到的弹性公网IP地址,IPv6时是IPv6地址对应的IPv4地址

    public_ipv6_address

    String

    IPv4时无此字段,IPv6时为申请到的弹性公网IP地址

    ip_version

    Integer

    IP版本信息,取值范围是4和6

    • 4:表示IPv4
    • 6:表示IPv6

    tenant_id

    String

    项目ID

    create_time

    String

    弹性公网IP申请时间(UTC)

    bandwidth_size

    Integer

    带宽大小

  • 响应样例1
    包年包月场景
    {
        "order_id": "CS1802081410IMDRN"
    }
  • 响应样例2
    按需场景
    {
      "publicip": {
        "id": "4eaf3b63-48ca-4410-ab85-bdfddf4b35fd",
        "status": "PENDING_CREATE",
        "type": "5_bgp",
        "public_ip_address": "10.xx.xx.238",
        "tenant_id": "26ae5181a416420998eb2093aaed84d9",
        "create_time": "2019-03-27 13:11:58",
        "bandwidth_size": 0,
        "enterprise_project_id": "0",
        "ip_version": 4
      }
    }

状态码

请参见状态码

错误码

请参考错误码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区