文档首页/ 弹性公网IP EIP/ API参考/ API/ 带宽(V2.0)/ 更新包周期带宽 - UpdatePrePaidBandwidth

更新时间：2025-10-24 GMT+08:00

在线调试

CLI示例

查看PDF

更新包周期带宽 - UpdatePrePaidBandwidth

功能介绍

更新包周期带宽，当前接口支持更新包周期的共享带宽。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。

如果使用身份策略授权，需具备如下身份策略权限。

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
eip:bandwidths:update	Write	bandwidth *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	vpc:bandwidths:update	-

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID，获取项目ID请参见获取项目ID
bandwidth_id	是	String	带宽唯一标识。

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
bandwidth	是	UpdatePrePaidBandwidthOption object	带宽对象
extendParam	否	UpdatePrePaidBandwidthExtendParamOption object	功能说明：扩展参数，用于续费升降配场景。即时升降配场景则不需要携带。

表3 UpdatePrePaidBandwidthOption
参数	是否必选	参数类型	描述
name	否	String	功能说明：带宽名称取值范围：1-64个字符，支持数字、字母、中文、_（下划线）、-（中划线）、.（点），为空表示不修改名称约束：和参数size必须有一个参数有值最小长度：1 最大长度：64
size	否	Integer	功能说明：修改后的带宽大小取值范围：默认1Mbit/s～2000Mbit/s（具体范围以各区域配置为准，请参见控制台对应页面显示），不带此参数时表示不修改大小。约束：和参数name必须有一个参数有值。注意：调整带宽时的最小单位会根据带宽范围不同存在差异。小于等于300Mbit/s：默认最小单位为1Mbit/s。 300Mbit/s~1000Mbit/s：默认最小单位为50Mbit/s。大于1000Mbit/s：默认最小单位为500Mbit/s。

表4 UpdatePrePaidBandwidthExtendParamOption
参数	是否必选	参数类型	描述
period_type	否	String	功能说明：变更资源的周期类型（包年、包月等），可选字段。取值范围： month-月 year-年约束：只有在资源续费降配的时候必须传，其他场景不需要传，如果传入默认忽略。
period_num	否	Integer	功能说明：订购周期数，和period_type同步传入，可选字段取值范围：（后续会随运营策略变化） period_type为month时，为[1,9] period_type为year时，为[1,3] 约束：只有在资源续费降配的时候必须传，其他场景不需要传，如果传入默认忽略。该字段需要和period_type同步传入或同步不传最小值：1 最大值：9
is_auto_pay	否	Boolean	功能说明：下单订购后，是否自动从客户的账户中支付，而不需要客户手动去进行支付；系统默认是“非自动支付”。取值范围： true：是（自动支付，从账户余额自动扣费） false：否（默认值，需要客户手动去支付）约束：资源升配或续费降配时，该参数为必传字段。自动支付时，只能使用账户的现金支付；如果要使用代金券，请选择不自动支付，然后在用户费用中心，选择代金券支付。缺省值：false

响应参数

状态码：200

表5 响应Body参数
参数	参数类型	描述
bandwidth	BandwidthResp object	带宽对象（按需场景和包周期只更新name时，返回该对象）
order_id	String	订单号（包周期场景返回该字段）最大长度：36

表6 BandwidthResp
参数	参数类型	描述
bandwidth_type	String	功能说明：带宽类型，共享带宽默认为share。取值范围：share，share_sbgp share：通用共享带宽 share_sbgp：静态共享带宽最小长度：1 最大长度：36
billing_info	String	功能说明：账单信息，如果billinginfo不为空，说明是包周期的带宽最小长度：0 最大长度：255
charge_mode	String	功能说明：按流量计费，按带宽计费还是按增强型95计费。取值范围：bandwidth（按带宽计费），traffic（按流量计费），95peak_plus（按增强型95计费），不返回或者为空时表示是bandwidth。约束：只有共享带宽支持95peak_plus（按增强型95计费），按增强型95计费时需要指定保底百分比，默认是20%。
id	String	功能说明：带宽唯一标识最大长度：36
name	String	功能说明：带宽名称取值范围：1-64个字符，支持数字、字母、中文、_（下划线）、-（中划线）、.（点）最小长度：1 最大长度：64
publicip_info	Array of PublicipInfoResp objects	功能说明：带宽对应的弹性公网IP信息约束：WHOLE类型的带宽支持多个弹性公网IP，PER类型的带宽只能对应一个弹性公网IP
share_type	String	功能说明：共享带宽类型，标识是否是共享带宽取值范围：PER，WHOLE（PER为独占带宽，WHOLE是共享带宽）。
size	Integer	功能说明：带宽大小取值范围：默认1Mbit/s~2000Mbit/s（具体范围以各区域配置为准，请参见控制台对应页面显示）。
tenant_id	String	功能说明：用户所属租户ID 最大长度：36
enterprise_project_id	String	企业项目ID。最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。创建弹性公网IP时，给弹性公网IP绑定企业项目ID。不指定该参数时，默认值是 0 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。最大长度：36
status	String	功能说明：带宽的状态取值范围： FREEZED：冻结 NORMAL：正常
enable_bandwidth_rules	Boolean	功能说明：是否开启企业级qos 取值范围：true/false。（该字段目前在华南-广州、华南-广州-友好用户环境、华南-深圳、西南-贵阳一、华东-上海一、华北-北京四、中国-香港、亚太-新加坡局点返回，后续其他局点将陆续开放）
rule_quota	Integer	功能说明：带宽支持的最大分组规则数。（该字段目前在华南-广州、华南-广州-友好用户环境、华南-深圳、西南-贵阳一、华东-上海一、华北-北京四、中国-香港、亚太-新加坡局点返回，后续其他局点将陆续开放）最小值：0 最大值：1024
bandwidth_rules	Array of BandWidthRules objects	功能说明：带宽规则对象。（该字段目前在华南-广州、华南-广州-友好用户环境、华南-深圳、西南-贵阳一、华东-上海一、华北-北京四、中国-香港、亚太-新加坡局点返回，后续其他局点将陆续开放）
created_at	String	功能说明：资源创建时间，UTC时间格式： yyyy-MM-ddTHH:mm:ss
updated_at	String	功能说明：资源更新时间，UTC时间格式： yyyy-MM-ddTHH:mm:ss
public_border_group	String	功能说明：表示中心站点资源或者边缘站点资源取值范围： center、边缘站点名称约束：共享带宽只能绑定与该字段相同的publicip 最小长度：1 最大长度：64

表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能力

请求示例

将宽带的大小更新为10M，名称更新为bandwidth123，下单订购后，需要客户手动去支付。

{
  "extendParam" : {
    "is_auto_pay" : "false"
  },
  "bandwidth" : {
    "size" : 10,
    "name" : "bandwidth123"
  }
}

响应示例

状态码：200

GET和PUT操作正常返回

{
  "bandwidth" : {
    "tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c",
    "size" : 10,
    "share_type" : "PER",
    "bandwidth_type" : "bgp",
    "publicip_info" : [ {
      "publicip_id" : "6285e7be-fd9f-497c-bc2d-dd0bdea6efe0",
      "ip_version" : 4,
      "publicip_type" : "5_bgp",
      "publicip_address" : "161.xx.xx.9"
    } ],
    "name" : "bandwidth123",
    "id" : "3fa5b383-5a73-4dcb-a314-c6128546d855",
    "charge_mode" : "bandwidth",
    "enable_bandwidth_rules" : false,
    "rule_quota" : 0,
    "bandwidth_rules" : [ ],
    "billing_info" : "",
    "status" : "NORMAL"
  },
  "order_id" : "xxxx"
}

状态码

状态码	描述
200	GET和PUT操作正常返回

错误码

请参见错误码。

父主题：带宽(V2.0)

上一篇：共享带宽插入弹性公网IP - AddPublicipsIntoSharedBandwidth

下一篇：共享带宽移除弹性公网IP - RemovePublicipsFromSharedBandwidth

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

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

盘古Doer提问云社区提问