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

更新带宽

功能介绍

更新带宽。

URI

PUT /v1/{project_id}/bandwidths/{bandwidth_id}

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

名称

是否必选

说明

project_id

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

bandwidth_id

带宽唯一标识

请求消息

  • 请求参数
    表2 请求参数

    名称

    是否必选

    参数类型

    说明

    bandwidth

    bandwidth object

    带宽对象,请参见表3

    表3 bandwidth字段说明

    名称

    是否必选

    参数类型

    说明

    name

    String

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

    size

    Integer

    • 功能说明:带宽大小,单位Mbit/s。
    • 取值范围:默认1Mbit/s~300Mbit/s(具体范围以各区域配置为准,请参见控制台对应页面显示),不带此参数时表示不修改大小。
    • 约束:name、size必须要有一个参数有值
    • 如果传入的参数为小数(如 10.2)或者字符类型(如“10”),会自动强制转换为整数。
    • 调整带宽时的最小单位会根据带宽范围不同存在差异。
      • 小于等于300Mbit/s:默认最小单位为1Mbit/s。
      • 300Mbit/s~1000Mbit/s:默认最小单位为50Mbit/s。
      • 大于1000Mbit/s:默认最小单位为500Mbit/s。
  • 请求样例
    PUT https://{Endpoint}/v1/{project_id}/bandwidths/{bandwidth_id} 
    
    {
        "bandwidth":
            {"name": "bandwidth123",
             "size": 10
            }
    }

响应消息

  • 响应参数
    表4 响应参数

    名称

    参数类型

    说明

    bandwidth

    bandwidth object

    带宽对象,请参见表5

    表5 bandwidth字段说明

    名称

    参数类型

    说明

    name

    String

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

    size

    Integer

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

    id

    String

    带宽唯一标识

    share_type

    String

    • 取值为PER,表示独享带宽

    publicip_info

    Array of publicip_info objects

    • 功能说明:带宽对应的信息。详见表6

    tenant_id

    String

    项目ID

    bandwidth_type

    String

    • 功能说明:带宽类型。
    • 取值范围:取值为bgp

    charge_mode

    String

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

    status

    String

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

    created_at

    String

    • 功能说明:资源创建时间,UTC时间
    • 格式:yyyy-MM-ddTHH:mm:ss

    updated_at

    String

    • 功能说明:资源更新时间,UTC时间
    • 格式:yyyy-MM-ddTHH:mm:ss
    表6 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": "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",
            "charge_mode": "bandwidth",
            "status": "NORMAL"
        }
    }

状态码

请参见状态码

错误码

请参考错误码