调用UpdateBandwidthPackage修改带宽包的配置_全球加速(GA)-阿里云帮助中心

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

接口说明

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

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
ga:UpdateBandwidthPackage	update	BandwidthPackage acs:ga:{#regionId}:{#accountId}:bandwidthpackage/{#bandwidthPackageId}	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	全球加速实例所在的地域 ID，仅取值cn-hangzhou。	cn-hangzhou
BandwidthPackageId	string	是	要修改的带宽包的 ID。	gbwp-bp1sgzldyj6b4q7cx****
Name	string	否	带宽包的名称。名称长度为 2~128 个英文或中文字符，以大小字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。	testName
Description	string	否	带宽包的描述信息。描述长度最大为 256 个字符。	testDescription
Bandwidth	integer	否	带宽包的带宽值。单位：Mbps。取值范围：2~2000。	2
BandwidthType	string	否	带宽类型。取值： Basic：标准加速带宽。 Enhanced：增强加速带宽。 Advanced：精品加速带宽。说明目前，仅支持 Basic 与 Enhanced 间变配，不支持 Advanced 与其他类型间进行变配。	Basic
AutoPay	boolean	否	是否自动付费。取值： false（默认值）：不开启自动付费。生成订单后需要到订单中心完成支付。 true：开启自动付费，自动支付订单。说明本参数仅对升配订单生效。	false
AutoUseCoupon	boolean	否	是否使用代金券。取值： true：使用。 false（默认值）：不使用。	false

返回参数

名称	类型	描述	示例值
	object	返回信息列表。
BandwidthPackage	string	带宽包 ID。	gbwp-bp1eo4f57z1kbbcmn****
Description	string	带宽包的描述信息。	testDescription
RequestId	string	请求 ID。	1DF3A3CB-B621-44F8-9870-C20D034D7AB
Name	string	带宽包的名称。	testName

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	COMMODITY.INVALID_COMPONENT	The Basic type only can be upgraded to the Enhanced, and the Enhanced type only can be downgraded to the Basic . The type of the Advance bandwidth can not be changed.	-
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.	带宽包变配项目应当全是升配或降配

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史