调用UpdateBandwidthPackage接口修改带宽包的配置。

使用说明

在调用本接口时，请注意以下事项：

  • 不涉及带宽值修改时，UpdateBandwidthPackage接口属于同步接口，修改完成后即时生效。
  • 涉及带宽值修改，且该带宽包未绑定全球加速实例时，UpdateBandwidthPackage接口属于异步接口，即系统会先返回一个请求ID，但带宽包并未修改完成。系统后台的修改任务仍在进行。您可以调用DescribeBandwidthPackage查询带宽包配置是否完成修改：
    • 当修改的参数值未发生变更，表示带宽包正在修改中，在该情况下，您只能执行查询操作，不能执行其他操作。
    • 当修改的参数值已发生变更，表示修改完成。
  • 涉及带宽值修改，且该带宽包已绑定全球加速实例时，UpdateBandwidthPackage接口属于异步接口，即系统会先返回一个请求ID，但带宽包并未修改完成。系统后台的修改任务仍在进行。您可以调用DescribeAccelerator，通过查询全球加速实例的状态，了解带宽包是否修改完成：
    • 当全球加速实例处于configuring状态时，表示绑定全球加速实例的带宽包正在修改中，在该状态下，您只能执行查询操作，不能执行其他操作。
    • 当全球加速实例处于active状态时，表示绑定全球加速实例的带宽包修改完成。
  • UpdateBandwidthPackage接口不支持并发修改同一个带宽包的配置。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 UpdateBandwidthPackage

系统规定参数。取值：UpdateBandwidthPackage。

RegionId String 是 cn-hangzhou

全球加速实例所在的地域ID，仅取值cn-hangzhou。

BandwidthPackageId String 是 gbwp-bp1sgzldyj6b4q7cx****

要修改的带宽包的ID。
Name String 否 testName

带宽包的名称。

名称长度为2~128个英文或中文字符，以大小字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。
Description String 否 testDescription

带宽包的描述信息。

描述长度最大为256个字符。
Bandwidth Integer 否 2

带宽包的带宽值。单位：Mbps。

取值范围：2~2000。

BandwidthType String 否 Basic

带宽类型。取值：

  • Basic：标准加速带宽。
  • Enhanced：增强加速带宽。
  • Advanced：精品加速带宽。
说明 目前，仅支持Basic变配到Enhanced，而不支持将Enhanced和Advanced变配到其他类型的加速带宽。
AutoPay Boolean 否 false

是否自动付费。取值：

  • false（默认值）：不开启自动付费，生成订单后需要到订单中心完成支付。
  • true：开启自动付费，自动支付订单。
AutoUseCoupon Boolean 否 false

是否使用代金券。取值：

  • true：使用。
  • false（默认值）：不使用。

返回数据

名称 类型 示例值 描述
BandwidthPackage String gbwp-bp1eo4f57z1kbbcmn****

带宽包ID。
Description String testDescription

带宽包的描述信息。
RequestId String 1DF3A3CB-B621-44F8-9870-C20D034D7AB

请求ID。
Name String testName

带宽包的名称。

示例

请求示例

http(s)://[Endpoint]/?Action=UpdateBandwidthPackage
&RegionId=cn-hangzhou
&BandwidthPackageId=gbwp-bp1sgzldyj6b4q7cx****
&Name=testName
&Description=testDescription
&Bandwidth=2
&BandwidthType=Basic
&AutoPay=false
&AutoUseCoupon=false
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateBandwidthPackageResponse>
    <BandwidthPackage>gbwp-bp1eo4f57z1kbbcmn****</BandwidthPackage>
    <Description>testDescription</Description>
    <RequestId>1DF3A3CB-B621-44F8-9870-C20D034D7AB</RequestId>
    <Name>testName</Name>
</UpdateBandwidthPackageResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "BandwidthPackage" : "gbwp-bp1eo4f57z1kbbcmn****",
  "Description" : "testDescription",
  "RequestId" : "1DF3A3CB-B621-44F8-9870-C20D034D7AB",
  "Name" : "testName"
}

错误码

HttpCode 错误码 错误信息 描述
400 StateError.BandwidthPackage The state of bandwidth package is invalid. 带宽包状态非法
400 NotExist.BandwidthPackage The bandwidth package does not exist. 带宽包不存在
400 UpgradeError.BandwidthPackage The bandwidth package configurations should be either all upgrades or all downgrades. 带宽包变配项目应当全是升配或降配

访问错误中心查看更多错误码。