すべてのプロダクト
Search

このプロダクト

    Tair (Redis® OSS-Compatible):EnableAdditionalBandwidth

    ドキュメントセンター

    Tair (Redis® OSS-Compatible):EnableAdditionalBandwidth

    最終更新日:Sep 16, 2026

    Tair (Redis® OSS 互換) インスタンスの帯域幅を調整します。現在、サポートされている課金方法は従量課金メソッドのみです。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

    任意

    クーポンコード。

    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

    任意

    バースト可能 (秒レベル) なエラスティック帯域幅を有効にするかどうかを指定します。エラスティック帯域幅のスケーリングが有効になっている場合、バースト可能 (秒レベル) なエラスティック帯域幅は有効にできません。逆も同様です。

    false

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    OrderId

    string

    注文の ID。

    2084452111111
    RequestId

    string

    リクエストの ID。

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

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

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

    変更履歴

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