調用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 |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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 |
AutoPay | boolean | 否 | false | |
AutoUseCoupon | boolean | 否 | 是否使用代金券。取值:
| false |
返回參數
示例
正常返回示例
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. | 帶寬包變配項目應當全是升配或降配 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|
暫無變更歷史