すべてのプロダクト
Search

このプロダクト

    Tair (Redis® OSS-Compatible):EnableAdditionalBandwidth

    ドキュメントセンター

    Tair (Redis® OSS-Compatible):EnableAdditionalBandwidth

    最終更新日:Mar 30, 2026

    この操作は、従量課金方式を使用する ApsaraDB for Redis インスタンスの帯域幅を調整します。InstanceId、NodeId (オプション)、Bandwidth、および ChargeType パラメーターのみを指定する必要があります。

    操作説明

    この操作を呼び出すときに帯域幅の自動スケーリングが有効になっている場合、自動スケーリング機能が優先されます。帯域幅がスケールバックされると、インスタンスタイプのデフォルトの帯域幅に戻ります。この機能の制限事項、課金の詳細、およびよくある質問については、「インスタンスの帯域幅の調整」をご参照ください。

    説明

    この操作を呼び出す前に、DescribeRoleZoneInfo 操作を呼び出して、インスタンスの各データノードの現在の帯域幅をクエリできます。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    kvstore:EnableAdditionalBandwidth

    update

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    InstanceId

    string

    必須

    インスタンス ID。 DescribeInstances 操作を呼び出してインスタンス ID をクエリできます。

    r-bp1zxszhcgatnx****
    CouponNo

    string

    任意

    クーポン ID。

    youhuiquan_promotion_option_id_for_blank
    AutoPay

    boolean

    任意

    自動支払いを有効にするかどうかを指定します。有効な値：

    • true：自動支払いを有効にします。これがデフォルトです。アカウントに十分な残高があることを確認してください。

    • false：自動支払いを無効にします。手動で支払いを完了する必要があります。

    true
    NodeId

    string

    任意

    データシャードの ID。 DescribeLogicInstanceTopology 操作を呼び出して、データシャード ID をクエリできます。複数のデータシャード ID はコンマ (,) で区切ります。このパラメーターを All に設定して、すべてのデータシャードを指定することもできます。

    説明

    このパラメーターは、インスタンスがクラスタアーキテクチャまたは読み書き分離アーキテクチャを使用している場合にのみ必要です。

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

    string

    任意

    追加する帯域幅の量 (MB/s)。値は 0 以上の整数である必要があります。最大値は、インスタンスタイプまたは単一のデータシャードのデフォルト帯域幅の 6 倍で、上限は 192 MB/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****

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。