# 更新包周期带宽 - UpdatePrePaidBandwidth #### 功能介绍 更新包周期带宽，当前接口支持更新包周期的共享带宽 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/EIP/doc?api=UpdatePrePaidBandwidth&version=v2)中调试该接口，支持自动认证鉴权。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-eip/eip_apipermission_0000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | eip:bandwidths:update | Write | bandwidth \* | - g:EnterpriseProjectId - g:ResourceTag/\ | vpc:bandwidths:update | - | #### URI PUT /v2.0/{project_id}/bandwidths/{bandwidth_id} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID [参见获取项目ID](https://support.huaweicloud.com/api-eip/eip_api06_0004.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | bandwidth_id | 是 | String | **参数解释：** 带宽唯一标识。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | bandwidth | 是 | [UpdatePrePaidBandwidthOption] object | 带宽对象 | | extendParam | 否 | [UpdatePrePaidBandwidthExtendParamOption] object | - 参数解释：扩展参数，用于续费升降配场景。即时升降配场景则不需要携带。 | 表3UpdatePrePaidBandwidthOption | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | **参数解释：** 带宽名称。 **约束限制：** 和参数size必须有一个参数有值。 **取值范围：** 1-64个字符，支持数字、字母、中文、_（下划线）、-（中划线）、.（点）为空表示不修改名称。 **默认取值：** 不涉及。 | | size | 否 | Integer | **参数解释：** 修改后的带宽大小。 **约束限制：** - 和参数name必须有一个参数有值。 - 注意：调整带宽时的最小单位会根据带宽范围不同存在差异。 - 小于等于300Mbit/s：默认最小单位为1Mbit/s。 - 300Mbit/s\~1000Mbit/s：默认最小单位为50Mbit/s。 - 大于1000Mbit/s：默认最小单位为500Mbit/s。 **取值范围：** 默认1Mbit/s～2000Mbit/s（具体范围以各区域配置为准，请参见控制台对应页面显示），不带此参数时表示不修改大小。 **默认取值：** 不涉及。 | 表4UpdatePrePaidBandwidthExtendParamOption | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | period_type | 否 | String | **参数解释：** 变更资源的周期类型（包年、包月等），可选字段。 **约束限制：** 只有在资源续费降配的时候必须传，其他场景不需要传，如果传入默认忽略。 **取值范围：** - month:月。 - year:年。 **默认取值：** 不涉及。 | | period_num | 否 | Integer | **参数解释：** 订购周期数，和period_type同步传入，可选字段。 **约束限制：** 只有在资源续费降配的时候必须传，其他场景不需要传，如果传入默认忽略。该字段需要和period_type同步传入或同步不传。 **取值范围：** - 后续会随运营策略变化。 - period_type为month时，为\[1,9\]。 - period_type为year时，为\[1,3\]。 **默认取值：** 不涉及。 | | is_auto_pay | 否 | Boolean | **参数解释：** 下单订购后，是否自动从客户的账户中支付，而不需要客户手动去进行支付；系统默认是"非自动支付"。 **约束限制：** 资源升配或续费降配时，该参数为必传字段。自动支付时，只能使用账户的现金支付；如果要使用代金券，请选择不自动支付，然后在用户费用中心，选择代金券支付。 **取值范围：** - true：是（自动支付，从账户余额自动扣费）。 - false：否（默认值，需要客户手动去支付）。 **默认取值：** 不涉及。 缺省值：**false** | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | bandwidth | [BandwidthResp] object | 带宽对象（按需场景和包周期只更新name时，返回该对象） | | order_id | String | **参数解释：** 订单号（包周期场景返回该字段）。 **取值范围：** 最大长度36。 | 表6BandwidthResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | bandwidth_type | String | **参数解释：** 带宽类型，共享带宽默认为share。 **取值范围：** - share：通用共享带宽。 - share_sbgp：静态共享带宽。 | | billing_info | String | **参数解释：** 账单信息，如果billinginfo不为空，说明是包周期的带宽。 **取值范围：** 0-255 | | charge_mode | String | **参数解释：** 按流量计费，按带宽计费还是按增强型95计费。只有共享带宽支持95peak_plus（按增强型95计费），按增强型95计费时需要指定保底百分比，默认是20%。 **取值范围：** bandwidth（按带宽计费），traffic（按流量计费），95peak_plus（按增强型95计费），不返回或者为空时表示是bandwidth。 | | id | String | **参数解释：** 带宽唯一标识。 **取值范围：** 最大长度36。 | | name | String | **参数解释：** 带宽名称。 **取值范围：** 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。创建共享带宽时，给共享带宽绑定企业项目ID。 **取值范围：** 最大长度36字节，带"-"连字符的UUID格式，或者是字符串"0"。"0"表示默认企业项目。 **说明：** 关于企业项目ID的获取及企业项目特性的详细信息，请参见[《企业管理用户指南》](https://support.huaweicloud.com/usermanual-em/zh-cn_topic_0126101490.html) | | 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、边缘站点名称。 | 表7BandWidthRules | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 带宽规则ID。 **取值范围：** 最大长度36 | | name | String | **参数解释：** 带宽规则名称。 **取值范围：** 0-64个字符。 | | admin_state_up | Boolean | **参数解释：** 配置状态，为False时配置不生效。 **取值范围：** 不涉及。 | | egress_size | Integer | **参数解释：** 出网带宽最大值，单位Mbps。 **取值范围：** \[0,n\]，其中n为所属带宽的带宽大小（size字段）。0为默认取值，表示设置为最大带宽。 | | egress_guarented_size | Integer | **参数解释：** 出网保障带宽大小，单位Mbps。 **取值范围：** \[0,x\]，其中x为所属带宽剩余的保障额，0为默认取值。 | | publicip_info | Array of [PublicipInfoResp] objects | **参数解释：** 带宽对应的弹性公网IP信息。 **取值范围：** 不涉及。 | 表8PublicipInfoResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | publicip_address | String | **参数解释：** 弹性公网IP或者IPv6端口的地址。 **取值范围：** 最大长度15。 | | publicip_id | String | **参数解释：** 带宽对应的弹性公网IP或者IPv6端口的唯一标识。 **取值范围：** 最大长度36。 | | publicip_type | String | **参数解释：** 弹性公网IP的类型。 **取值范围：** 5_bgp (全动态BGP)，5_sbgp (静态BGP)，5_bgp-premium(精品BGP) - 华南-广州：5_bgp、5_sbgp - 华东-上海一：5_bgp、5_sbgp - 华东-上海二：5_bgp、5_sbgp - 华北-北京一：5_bgp、5_sbgp - 中国-香港：5_bgp、5_bgp-premium - 亚太-曼谷：5_bgp - 亚太-新加坡：5_bgp - 非洲-约翰内斯堡：5_bgp - 西南-贵阳一：5_sbgp - 华北-北京四：5_bgp、5_sbgp - 拉美-圣地亚哥：5_bgp - 拉美-圣保罗一：5_bgp - 拉美-墨西哥城一：5_bgp - 拉美-布宜诺斯艾利斯一：5_bgp - 拉美-利马一：5_bgp - 拉美-圣地亚哥二： 5_bgp | | 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** ``` { "bandwidth" : { "tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c", "size" : 10, "share_type" : "WHOLE", "bandwidth_type" : "share", "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" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 将带宽的大小更新为10M，名称更新为bandwidth123，下单订购后，需要客户手动去支付 ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.eip.v2.region.EipRegion; import com.huaweicloud.sdk.eip.v2.*; import com.huaweicloud.sdk.eip.v2.model.*; public class UpdatePrePaidBandwidthSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); EipClient client = EipClient.newBuilder() .withCredential(auth) .withRegion(EipRegion.valueOf("")) .build(); UpdatePrePaidBandwidthRequest request = new UpdatePrePaidBandwidthRequest(); request.withBandwidthId("{bandwidth_id}"); UpdatePrePaidBandwidthRequestBody body = new UpdatePrePaidBandwidthRequestBody(); UpdatePrePaidBandwidthExtendParamOption extendParambody = new UpdatePrePaidBandwidthExtendParamOption(); extendParambody.withIsAutoPay(false); UpdatePrePaidBandwidthOption bandwidthbody = new UpdatePrePaidBandwidthOption(); bandwidthbody.withName("bandwidth123") .withSize(10); body.withExtendParam(extendParambody); body.withBandwidth(bandwidthbody); request.withBody(body); try { UpdatePrePaidBandwidthResponse response = client.updatePrePaidBandwidth(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] 将带宽的大小更新为10M，名称更新为bandwidth123，下单订购后，需要客户手动去支付 ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkeip.v2.region.eip_region import EipRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkeip.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = EipClient.new_builder() \ .with_credentials(credentials) \ .with_region(EipRegion.value_of("")) \ .build() try: request = UpdatePrePaidBandwidthRequest() request.bandwidth_id = "{bandwidth_id}" extendParambody = UpdatePrePaidBandwidthExtendParamOption( is_auto_pay=False ) bandwidthbody = UpdatePrePaidBandwidthOption( name="bandwidth123", size=10 ) request.body = UpdatePrePaidBandwidthRequestBody( extend_param=extendParambody, bandwidth=bandwidthbody ) response = client.update_pre_paid_bandwidth(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] 将带宽的大小更新为10M，名称更新为bandwidth123，下单订购后，需要客户手动去支付 ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" eip "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := eip.EipClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := eip.NewEipClient(hcClient) request := &model.UpdatePrePaidBandwidthRequest{} request.BandwidthId = "{bandwidth_id}" isAutoPayExtendParam:= false extendParambody := &model.UpdatePrePaidBandwidthExtendParamOption{ IsAutoPay: &isAutoPayExtendParam, } nameBandwidth:= "bandwidth123" sizeBandwidth:= int32(10) bandwidthbody := &model.UpdatePrePaidBandwidthOption{ Name: &nameBandwidth, Size: &sizeBandwidth, } request.Body = &model.UpdatePrePaidBandwidthRequestBody{ ExtendParam: extendParambody, Bandwidth: bandwidthbody, } response, err := client.UpdatePrePaidBandwidth(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/EIP/sdk?api=UpdatePrePaidBandwidth&version=v2)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | GET和PUT操作正常返回 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-eip/ErrorCode.html)。