全部產品
Search

搜尋本產品

    Tair (Redis® OSS-Compatible)：EnableAdditionalBandwidth - 調整執行個體頻寬

    文件中心

    Tair (Redis® OSS-Compatible)：EnableAdditionalBandwidth - 調整執行個體頻寬

    更新時間：Mar 30, 2026

    調整雲資料庫 Tair（相容 Redis）執行個體的頻寬，當前僅支援隨用隨付的計費方式，您僅需填寫InstanceId、NodeId（可選）、Bandwidth、ChargeType參數即可。

    介面說明

    若您在調用本介面的同時，開啟了執行個體頻寬Auto Scaling功能，則執行個體會優先使用頻寬Auto Scaling功能，且在頻寬彈性回縮時，將回縮至執行個體規格的預設頻寬。更多關於該功能限制、費用說明及常見問題，請參見調整執行個體頻寬。

    說明

    調用本介面前，您可以調用 DescribeRoleZoneInfo 查詢執行個體中各資料節點的當前頻寬。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    kvstore:EnableAdditionalBandwidth

    update

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    InstanceId

    string

    是

    執行個體 ID，可調用 DescribeInstances 擷取。

    r-bp1zxszhcgatnx****
    CouponNo

    string

    否

    優惠券編號。

    youhuiquan_promotion_option_id_for_blank
    AutoPay

    boolean

    否

    是否自動付款，取值：

    • true：預設值，自動付款，請確保帳號有足夠的餘額。

    • false：手動付款。

    true
    NodeId

    string

    否

    資料分區 ID，您可以調用 DescribeLogicInstanceTopology 擷取，傳入多個時使用英文逗號（,）分隔；您也可以傳入 All（即表示所有資料分區）。

    說明

    當執行個體為叢集架構或讀寫分離架構時，本參數才可用且必須傳入。

    r-bp1zxszhcgatnx****-db-0
    Bandwidth

    string

    否

    要增加的頻寬，單位為 MB/s。取值為大於等於 0 的整數 ，最大可傳入該執行個體（或單分區）規格預設頻寬的 6 倍，但增加的上限為 192MB/s。例如執行個體預設頻寬為 10 MB/s，可增加的範圍為 0~60。

    說明

    • 您可以調用 DescribeRoleZoneInfo 介面，通過返回參數 DefaultBandWidth 擷取預設最大頻寬。更多關於執行個體規格的資訊，請參見執行個體規格查詢導航。

    • 如果請求參數 NodeId 傳入了多個資料分區 ID，本參數傳入的頻寬值需和資料分區 ID 的順序對應，多個頻寬值之間使用英文逗號（,）分隔。

    20
    OrderTimeLength

    string

    否

    購買的時間長度，單位為天，取值：1、2、3、7、14、30、60、90、180、365、730、1095、1825。

    說明

    如果需要繼續使用購買的頻寬，您需要在頻寬到期前調用 RenewAdditionalBandwidth 介面及時續約。

    30
    SourceBiz

    string

    否

    調用來源，本參數僅用於內部維護使用，無需傳入。

    SDK
    AutoRenew

    boolean

    否

    是否開啟自動續約，取值：

    • true：開啟。

    • false：不開啟，預設值。

    false
    AutoRenewPeriod

    integer

    否

    自動續約周期，單位為月，取值：1、2、3、4、5、6、7、8、9、12、24、36、60。

    說明

    • 當 AutoRenew 參數取值為 true 時，本參數才可用且必須傳入。

    • 該參數設定後暫不支援通過 API 查詢，您可以在控制台的頂部功能表列，單擊費用 > 續約管理，然後在執行個體 ID文字框中輸入執行個體 ID 加-bw尾碼（例如 r-bp1zxszhcgatnx****-bw）來查詢。

    1
    ChargeType

    string

    否

    額外增加頻寬的付費類型，取值：

    • PrePaid：預付費，即訂用帳戶。

    • PostPaid：隨用隨付，當前僅支援該方式。

    PrePaid
    BandWidthBurst

    boolean

    否

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    OrderId

    string

    訂單 ID。

    2084452111111
    RequestId

    string

    請求 ID。

    D622714-AEDD-4609-9167-F5DDD3D1****

    樣本

    正常返回樣本

    JSON格式

    {
  "OrderId": "2084452111111",
  "RequestId": "D622714-AEDD-4609-9167-F5DDD3D1****"
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。