文档首页 > > API参考> API> 带宽(V2.0)> 更新包周期带宽

更新包周期带宽

分享
更新时间: 2019/08/31 18:43

功能介绍

更新带宽。

URI

PUT /v2.0/{project_id}/bandwidths/{bandwidth_id}

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

名称

是否必选

说明

project_id

项目ID

bandwidth_id

带宽唯一标识。通过查询弹性公网IP获取。

请求消息

  • 请求参数
    表2 请求参数

    名称

    是否必选

    参数类型

    说明

    bandwidth

    Object

    带宽对象,请参见表3

    extendParam

    Object

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

    表3 bandwidth字段说明

    名称

    是否必选

    参数类型

    说明

    name

    String

    • 功能说明:带宽名称
    • 取值范围:1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点),为空表示不修改名称
    • 约束:和参数size必须有一个参数有值

    size

    Integer

    • 功能说明:带宽大小,包周期的带宽只能改大。
    • 取值范围:默认1Mbit/s~2000Mbit/s(具体范围以各区域配置为准,请参见控制台对应页面显示),不带此参数时表示不修改大小。
    • 约束:和参数name必须有一个参数有值。
    • 注意:调整带宽时的最小单位会根据带宽范围不同存在差异。
      • 小于等于300Mbit/s:默认最小单位为1Mbit/s。
      • 300Mbit/s~1000Mbit/s:默认最小单位为50Mbit/s。
      • 大于1000Mbit/s:默认最小单位为500Mbit/s。
    表4 extendParam字段说明

    名称

    是否必选

    参数类型

    说明

    is_auto_pay

    String

    • 功能说明:下单订购后,是否自动从客户的账户中支付,而不需要客户手动去进行支付;系统默认是“非自动支付”。
    • 取值范围:
      • true:是(自动支付)
      • false:否(默认值,需要客户手动去支付)
    • 约束:

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

  • 请求样例
    PUT https://{Endpoint}/v2.0/{project_id}/bandwidths/{bandwidth_id}
    
    {
        "bandwidth": {
            "name": "bandwidth123",
            "size": 10
        },
        "extendParam": {
            "is_auto_pay": "false"
        }
    }

响应消息

  • 响应参数
    表5 响应参数

    名称

    参数类型

    说明

    bandwidth

    Object

    带宽对象(按需场景和包周期只更新name时,返回该对象)。请参见表6

    order_id

    String

    订单号(包周期场景返回该字段)

    说明:

    如果需要支付订单,请参考支付包周期产品订单

    表6 bandwidth字段说明

    名称

    参数类型

    说明

    name

    String

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

    size

    Integer

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

    id

    String

    带宽唯一标识

    share_type

    String

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

    publicip_info

    Array of publicip_info objects

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

    tenant_id

    String

    项目ID

    bandwidth_type

    String

    • 功能说明:带宽类型,共享带宽默认为share。
    • 取值范围:share,bgp,telcom,sbgp等
      • share:共享带宽
      • bgp:动态bgp
      • telcom :联通
      • sbgp:静态bgp

    charge_mode

    String

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

    billing_info

    String

    账单信息。

    如果billing_info不为空,说明是包周期的带宽。

    enterprise_project_id

    String

    • 企业项目ID。最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。创建共享带宽时,给共享带宽绑定企业项目ID。
    说明:

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

    status

    String

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

    名称

    参数类型

    说明

    publicip_address

    String

    功能说明:IPv4时是申请到的弹性公网IP地址,IPv6时为IPv6地址对应的IPv4地址

    publicipv6_address

    String

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

    ip_version

    Integer

    • 功能说明:IP版本信息
    • 取值范围:
      • 4:IPv4
      • 6:IPv6

    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_bgp、5_sbgp
      • 华北-北京四:5_bgp、5_sbgp
    • 约束:必须是系统具体支持的类型
  • 响应样例1(按需带宽或包周期带宽只更新name时)
    {
        "bandwidth": {
            "id": "3fa5b383-5a73-4dcb-a314-c6128546d855",
            "name": "bandwidth123",
            "size": 10,
            "share_type": "PER",
            "publicip_info": [
                {
                    "publicip_id": "6285e7be-fd9f-497c-bc2d-dd0bdea6efe0",
                    "publicip_address": "161.xx.xx.9",
                    "publicip_type": "5_bgp",
                    "ip_version": 4
                }
            ],
            "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
            "bandwidth_type": "bgp"
        }
    }
  • 响应样例2(包周期带宽)
    {
        "order_id": "xxxx"
    }

状态码

请参见状态码

错误码

请参考错误码

分享:

    相关文档

    相关产品

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

提交成功!

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

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

*必选

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

字符长度不能超过200

提交反馈 取消

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

跳转到云社区