更新时间:2024-04-15 GMT+08:00

共享带宽插入弹性公网IP

功能介绍

共享带宽插入弹性公网IP

URI

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

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

名称

是否必选

说明

project_id

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

bandwidth_id

带宽唯一标识

请求消息

  • 请求参数
    表2 请求参数

    名称

    是否必选

    参数类型

    说明

    bandwidth

    bandwidth object

    带宽对象,请参见表3

    表3 bandwidth字段说明

    名称

    是否必选

    参数类型

    说明

    publicip_info

    Array of publicip_info objects

    • 功能说明:要插入共享带宽的信息,请参见表4
    • 约束:WHOLE类型的带宽支持多个弹性公网IP,跟租户的配额相关,默认一个共享带宽的配额为20。
    表4 publicip_info对象

    名称

    是否必选

    参数类型

    说明

    publicip_id

    String

    带宽对应的的唯一标识

    publicip_type

    String

    • 功能说明:弹性公网IP的类型
    • 取值范围:5_bgp
    • 约束:
      • 必须是系统具体支持的类型
      • publicip_id为IPv4端口,所以"publicip_type"字段未给定时,默认为5_bgp。
  • 请求样例
    POST https://{Endpoint}/v2.0/{project_id}/bandwidths/{bandwidth_id}/insert
    
    {
      "bandwidth": {
        "publicip_info": [
          {
            "publicip_id": "29b114d1-2d41-4741-a1f0-b6f80aabceff",
            "publicip_type": "5_bgp",
          }
        ]
      }
    }

响应消息

  • 响应参数
    表5 响应参数

    名称

    参数类型

    说明

    bandwidth

    bandwidth object

    带宽对象,请参见表6

    表6 bandwidth字段说明

    名称

    参数类型

    说明

    name

    String

    • 功能说明:带宽名称
    • 取值范围:1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)

    size

    Integer

    • 功能说明:带宽大小。
    • 取值范围:默认1Mbit/s~2000Mbit/s(具体范围以各区域配置为准,请参见控制台对应页面显示)。

    id

    String

    带宽唯一标识

    share_type

    String

    • 功能说明:带宽类型,标识是否是共享带宽
    • 取值范围:WHOLE,PER
      • WHOLE表示共享带宽
      • PER表示独享带宽

    publicip_info

    Array of publicip_info objects

    • 功能说明:带宽对应的信息,请参见表7
    • 约束:WHOLE类型的带宽支持多个弹性公网IP,PER类型的带宽只能对应一个弹性公网IP

    tenant_id

    String

    项目ID

    bandwidth_type

    String

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

    charge_mode

    String

    • 功能说明:按流量计费还是按带宽计费。
    • 取值范围:bandwidth(按带宽计费),traffic(按流量计费),不返回或者为空时表示是bandwidth。
    • 约束:共享带宽仅支持按带宽计费。

    status

    String

    • 功能说明:带宽的状态
    • 取值范围:
      • FREEZED:冻结
      • NORMAL:正常
    表7 publicip_info对象

    名称

    参数类型

    说明

    publicip_id

    String

    功能说明:带宽对应的的唯一标识

    publicip_address

    String

    功能说明:IPv4时是申请到的弹性公网IP地址

    publicip_type

    String

    • 功能说明:弹性公网IP的类型
    • 取值范围:5_bgp
    • 约束:
      • 必须是系统具体支持的类型
      • publicip_id为IPv4端口,所以"publicip_type"字段未给定时,默认为5_bgp。
  • 响应样例
    {
        "bandwidth": {
            "id": "3fa5b383-5a73-4dcb-a314-c6128546d855",
            "name": "bandwidth123",
            "size": 10,
            "share_type": "WHOLE",
            "publicip_info": [
                {
                    "publicip_id": "1d184b2c-4ec9-49b5-a3f9-27600a76ba3f",
                    "publicip_address": "99.xx.xx.82",
                    "publicip_type": "5_bgp",
                    "ip_version": 4
                }
            ],
            "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
            "charge_mode": "traffic",
            "bandwidth_type": "share",
            "status": "NORMAL"
        }
    }

状态码

请参见状态码

错误码

请参考错误码