調(diào)用UpdateBandwidthPackage接口修改帶寬包的配置。
接口說(shuō)明
在調(diào)用本接口時(shí)，請(qǐng)注意以下事項(xiàng)：
- 不涉及帶寬值修改時(shí)，UpdateBandwidthPackage 接口屬于同步接口，修改完成后即時(shí)生效。
- 涉及帶寬值修改，且該帶寬包未綁定全球加速實(shí)例時(shí)，UpdateBandwidthPackage 接口屬于異步接口，即系統(tǒng)會(huì)先返回一個(gè)請(qǐng)求 ID，但帶寬包并未修改完成。系統(tǒng)后臺(tái)的修改任務(wù)仍在進(jìn)行。您可以調(diào)用 DescribeBandwidthPackage 查詢(xún)帶寬包配置是否完成修改：
- 當(dāng)修改的參數(shù)值未發(fā)生變更，表示帶寬包正在修改中，在該情況下，您只能執(zhí)行查詢(xún)操作，不能執(zhí)行其他操作。
- 當(dāng)修改的參數(shù)值已發(fā)生變更，表示修改完成。
- 涉及帶寬值修改，且該帶寬包已綁定全球加速實(shí)例時(shí)，UpdateBandwidthPackage 接口屬于異步接口，即系統(tǒng)會(huì)先返回一個(gè)請(qǐng)求 ID，但帶寬包并未修改完成。系統(tǒng)后臺(tái)的修改任務(wù)仍在進(jìn)行。您可以調(diào)用 DescribeAccelerator ，通過(guò)查詢(xún)?nèi)蚣铀賹?shí)例的狀態(tài)，了解帶寬包是否修改完成：
- 當(dāng)全球加速實(shí)例處于 configuring 狀態(tài)時(shí)，表示綁定全球加速實(shí)例的帶寬包正在修改中，在該狀態(tài)下，您只能執(zhí)行查詢(xún)操作，不能執(zhí)行其他操作。
- 當(dāng)全球加速實(shí)例處于 active 狀態(tài)時(shí)，表示綁定全球加速實(shí)例的帶寬包修改完成。
- UpdateBandwidthPackage 接口不支持并發(fā)修改同一個(gè)帶寬包的配置。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語(yǔ)句的Action元素中使用，用來(lái)給RAM用戶(hù)或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪(fǎng)問(wèn)級(jí)別：是指每個(gè)操作的訪(fǎng)問(wèn)級(jí)別，取值為寫(xiě)入（Write）、讀取（Read）或列出（List）。
- 資源類(lèi)型：是指操作中支持授權(quán)的資源類(lèi)型。具體說(shuō)明如下：
- 對(duì)于必選的資源類(lèi)型，用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪(fǎng)問(wèn)級(jí)別 | 資源類(lèi)型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| ga:UpdateBandwidthPackage | update |
|
| 無(wú) |
請(qǐng)求參數(shù)
| 名稱(chēng) | 類(lèi)型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 全球加速實(shí)例所在的地域 ID，僅取值cn-hangzhou。 | cn-hangzhou |
| BandwidthPackageId | string | 是 | 要修改的帶寬包的 ID。 | gbwp-bp1sgzldyj6b4q7cx**** |
| Name | string | 否 | 帶寬包的名稱(chēng)。 名稱(chēng)長(zhǎng)度為 2~128 個(gè)英文或中文字符，以大小字母或中文開(kāi)頭，可包含數(shù)字、半角句號(hào)（.）、下劃線(xiàn)（_）和短劃線(xiàn)（-）。 | testName |
| Description | string | 否 | 帶寬包的描述信息。 描述長(zhǎng)度最大為 256 個(gè)字符。 | testDescription |
| Bandwidth | integer | 否 | 帶寬包的帶寬值。單位：Mbps。 取值范圍：2~2000。 | 2 |
| BandwidthType | string | 否 | 帶寬類(lèi)型。取值：
說(shuō)明
目前，僅支持 Basic 與 Enhanced 間變配，不支持 Advanced 與其他類(lèi)型間進(jìn)行變配。
| Basic |
| AutoPay | boolean | 否 | 是否自動(dòng)付費(fèi)。取值：
說(shuō)明
本參數(shù)僅對(duì)升配訂單生效。
| false |
| AutoUseCoupon | boolean | 否 | 是否使用代金券。取值：
| false |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"BandwidthPackage": "gbwp-bp1eo4f57z1kbbcmn****",
"Description": "testDescription",
"RequestId": "1DF3A3CB-B621-44F8-9870-C20D034D7AB",
"Name": "testName"
}錯(cuò)誤碼
| HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
|---|---|---|---|
| 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. | 帶寬包狀態(tài)非法 |
| 400 | NotExist.BandwidthPackage | The bandwidth package does not exist. | 帶寬包不存在 |
| 400 | UpgradeError.BandwidthPackage | The bandwidth package configurations should be either all upgrades or all downgrades. | 帶寬包變配項(xiàng)目應(yīng)當(dāng)全是升配或降配 |
訪(fǎng)問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|
暫無(wú)變更歷史