文档首页> 弹性公网IP EIP> API参考> API> 带宽(V2.0)> 共享带宽插入弹性公网IP
更新时间：2024-04-26 GMT+08:00
在线调试
CLI示例
查看PDF
分享

共享带宽插入弹性公网IP

功能介绍

共享带宽插入弹性公网IP。

接口约束

共享带宽和弹性公网IP资源必须存在。在共享带宽中批量插入弹性公网IP时，一次可批量操作100个弹性公网IP。

调用方法

请参见如何调用API。

URI

POST /v2.0/{project_id}/bandwidths/{bandwidth_id}/insert

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取项目ID请参见获取项目ID

bandwidth_id

是

String

带宽唯一标识

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

bandwidth

是

AddPublicipsIntoSharedBandwidthOption object

带宽对象
表3 AddPublicipsIntoSharedBandwidthOption

参数

是否必选

参数类型

描述

publicip_info

是

Array of InsertPublicipInfo objects

  • 功能说明：要插入共享带宽的弹性公网IP信息或者IPv6端口

  • 约束：WHOLE类型的带宽支持多个弹性公网IP或者IPv6端口，跟租户的配额相关，默认一个共享带宽的配额为20
表4 InsertPublicipInfo

参数

是否必选

参数类型

描述

publicip_type

否

String

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

  • 取值范围：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。

最大长度：36

publicip_id

是

String

  • 功能说明：带宽对应的弹性公网IP或者IPv6端口PORT的唯一标识

最大长度：36

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

bandwidth

BandwidthRespInsert object

带宽对象
表6 BandwidthRespInsert

参数

参数类型

描述

bandwidth_type

String

  • 功能说明：带宽类型，共享带宽默认为share。

  • 取值范围：share，bgp，sbgp等。

    • share：共享带宽

    • bgp：动态bgp

    • sbgp：静态bgp

最小长度：1

最大长度：36

charge_mode

String

  • 功能说明：按流量计费,按带宽计费还是按增强型95计费。

  • 取值范围：bandwidth（按带宽计费），traffic（按流量计费），95peak_plus（按增强型95计费），不返回或者为空时表示是bandwidth。

  • 约束：只有共享带宽支持95peak_plus（按增强型95计费），按增强型95计费时需要指定保底百分比，默认是20%。

枚举值：

  • bandwidth

  • traffic

  • 95peak_plus

id

String

  • 功能说明：带宽唯一标识

最大长度：36

name

String

  • 功能说明：带宽名称

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

最小长度：1

最大长度：64

publicip_info

Array of PublicipInfoResp objects

  • 功能说明：带宽对应的弹性公网IP信息

  • 约束：WHOLE类型的带宽支持多个弹性公网IP，PER类型的带宽只能对应一个弹性公网IP

billing_info

String

  • 功能说明：账单信息，如果billinginfo不为空，说明是包周期的带宽

最小长度：0

最大长度：255

share_type

String

  • 功能说明：带宽类型，标识是否是共享带宽

  • 取值范围：WHOLE，PER

    • WHOLE表示共享带宽

    • PER表示独享带宽

枚举值：

  • WHOLE

  • PER

size

Integer

  • 功能说明：带宽大小。

  • 取值范围：默认5Mbit/s~2000Mbit/s（具体范围以各区域配置为准，请参见控制台对应页面显示）。

tenant_id

String

功能说明：用户所属租户ID

最大长度：36

enterprise_project_id

String

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

  • 创建共享带宽时，给共享带宽绑定企业项目ID。

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

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

最大长度：36

status

String

  • 功能说明：带宽的状态

  • 取值范围：

    • FREEZED：冻结

    • NORMAL：正常

枚举值：

  • FREEZED

  • NORMAL

enable_bandwidth_rules

Boolean

  • 功能说明：是否开启企业级qos

  • 取值范围：true/false

rule_quota

Integer

  • 功能说明：带宽支持的最大分组规则数。

最小值：0

最大值：1024

bandwidth_rules

Array of BandWidthRules objects

  • 功能说明：带宽规则对象
表7 BandWidthRules

参数

参数类型

描述

id

String

  • 功能说明：带宽规则ID

最大长度：36

name

String

  • 功能说明：带宽规则名称

最小长度：0

最大长度：64

admin_state_up

Boolean

  • 功能说明：配置状态，为False时配置不生效。

egress_size

Integer

  • 功能说明：出网带宽最大值，单位Mbps

  • 取值范围[0,n]，其中n为所属带宽的带宽大小（size字段）。0表示设置为最大带宽

最小值：0

缺省值：0

egress_guarented_size

Integer

  • 功能说明：出网保障带宽大小，单位Mbps

  • 取值范围[0,x]，其中x为所属带宽剩余的保障额

最小值：0

缺省值：0

publicip_info

Array of PublicipInfoResp objects

  • 功能说明：带宽对应的弹性公网IP信息

  • 约束：WHOLE类型的带宽支持多个弹性公网IP，PER类型的带宽只能对应一个弹性公网IP
表8 PublicipInfoResp

参数

参数类型

描述

publicip_address

String

  • 功能说明：功能说明：弹性公网IP或者IPv6端口的地址

最大长度：15

publicip_id

String

  • 功能说明：带宽对应的弹性公网IP或者IPv6端口的唯一标识

最大长度：36

publicip_type

String

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

  • 取值范围：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。

最大长度：36

publicipv6_address

String

  • 功能说明：IPv4时无此字段，IPv6时为申请到的弹性公网IP地址

最大长度：39

ip_version

Integer

  • 功能说明：IP版本信息

  • 取值范围：

    • 4：IPv4

    • 6：开启NAT64能力

枚举值：

  • 4

  • 6

请求示例

将id为d91b0028-6f6b-4478-808a-297b75b6812a、1d184b2c-4ec9-49b5-a3f9-27600a76ba3f的弹性公网IP插入共享带宽，支持多个弹性公网IP插入共享带宽。

{
  "bandwidth" : {
    "publicip_info" : [ {
      "publicip_id" : "d91b0028-6f6b-4478-808a-297b75b6812a",
      "publicip_type" : "5_dualStack"
    }, {
      "publicip_id" : "1d184b2c-4ec9-49b5-a3f9-27600a76ba3f"
    } ]
  }
}

响应示例

状态码： 200

POST操作正常返回

{
  "bandwidth" : {
    "tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c",
    "billing_info" : "CS1712121146TSQOJ:0616e2a5dc9f4985ba52ea8c0c7e273c:southchina:35f2b308f5d64441a6fa7999fbcd4321",
    "size" : 10,
    "share_type" : "WHOLE",
    "bandwidth_type" : "share",
    "publicip_info" : [ {
      "publicip_id" : "d91b0028-6f6b-4478-808a-297b75b6812a",
      "ip_version" : 4,
      "publicip_type" : "5_dualStack",
      "publicip_address" : "::ffff:192.168.89.9"
    }, {
      "publicip_id" : "1d184b2c-4ec9-49b5-a3f9-27600a76ba3f",
      "ip_version" : 4,
      "publicip_type" : "5_bgp",
      "publicip_address" : "99.xx.xx.82"
    } ],
    "name" : "bandwidth123",
    "enable_bandwidth_rules" : false,
    "rule_quota" : 0,
    "bandwidth_rules" : [ ],
    "charge_mode" : "bandwidth",
    "id" : "3fa5b383-5a73-4dcb-a314-c6128546d855"
  }
}

状态码

状态码

描述

200

POST操作正常返回

错误码

请参见错误码。

父主题： 带宽(V2.0)
分享：

    相关文档

    相关产品