調整云數據庫 Tair(兼容 Redis)實例的帶寬,當前僅支持按量付費的計費方式,您僅需填寫InstanceId、NodeId(可選)、Bandwidth、ChargeType參數即可。
接口說明
若您在調用本接口的同時,開啟了實例帶寬彈性伸縮功能,則實例會優先使用帶寬彈性伸縮功能,且在帶寬彈性回縮時,將回縮至實例規格的默認帶寬。更多關于該功能限制、費用說明及常見問題,請參見調整實例帶寬。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀?。≧ead)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
kvstore:EnableAdditionalBandwidth | update | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 實例 ID,可調用 DescribeInstances 獲取。 | r-bp1zxszhcgatnx**** |
CouponNo | string | 否 | 優惠券編號。 | youhuiquan_promotion_option_id_for_blank |
AutoPay | boolean | 否 | 是否自動付款,取值:
| true |
NodeId | string | 否 | 數據分片 ID,您可以調用 DescribeLogicInstanceTopology 獲取,傳入多個時使用英文逗號(,)分隔;您也可以傳入 All(即表示所有數據分片)。 | r-bp1zxszhcgatnx****-db-0 |
Bandwidth | string | 是 | 要增加的帶寬,單位為 MB/s。取值為大于等于 0 的整數 ,最大可傳入該實例(或單分片)規格默認帶寬的 6 倍,但增加的上限為 192MB/s。例如實例默認帶寬為 10 MB/s,可增加的范圍為 0~60。 說明
| 20 |
OrderTimeLength | string | 否 | 購買的時長,單位為天,取值:1、2、3、7、14、30、60、90、180、365、730、1095、1825。 說明
如果需要繼續使用購買的帶寬,您需要在帶寬到期前調用 RenewAdditionalBandwidth 接口及時續費。
| 30 |
SourceBiz | string | 否 | 調用來源,本參數僅用于內部維護使用,無需傳入。 | SDK |
AutoRenew | boolean | 否 | 是否開啟自動續費,取值:
| false |
AutoRenewPeriod | integer | 否 | 自動續費周期,單位為月,取值:1、2、3、4、5、6、7、8、9、12、24、36、60。 說明
-bw 后綴(例如 r-bp1zxszhcgatnx****-bw)來查詢。 | 1 |
ChargeType | string | 是 | 額外增加帶寬的付費類型,取值:
| PrePaid |
返回參數
示例
正常返回示例
JSON
格式
{
"OrderId": "2084452111111",
"RequestId": "D622714-AEDD-4609-9167-F5DDD3D1****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-06-06 | OpenAPI 入參發生變更 | 查看變更詳情 |