すべてのプロダクト
Search

このプロダクト

    PolarDB:ModifyDBCluster

    ドキュメントセンター

    PolarDB:ModifyDBCluster

    最終更新日:Oct 12, 2026

    PolarDB for MySQL クラスターの特徴設定を変更します。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    polardb:ModifyDBCluster

    update

    *DBCluster

    acs:polardb:{#regionId}:{#accountId}:DBCluster/{#DbClusterId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBClusterId

    string

    必須

    クラスターの ID。

    説明

    DescribeDBClusters 操作を呼び出して、クラスター ID を含む指定されたリージョンのすべてのクラスターをクエリできます。

    pc-*************
    StandbyHAMode

    string

    任意

    クラスターのクロスゾーン自動切り替えモード。有効な値:

    • ON: クロスゾーン自動切り替えを有効にします。

    • OFF: クロスゾーン自動切り替えを無効にします。

    ON
    DataSyncMode

    string

    任意

    クラスターのクロスゾーンデータレプリケーションモード。有効な値:

    • AsyncSync: 非同期。

    • SemiSync: 半同期。

    AsynSync
    FaultSimulateMode

    string

    任意

    クラスターのエラードリルディメンション。有効な値:

    • 0 または FaultInjection: プライマリゾーンディメンションのエラードリル。

    • 1: ノードディメンションのエラードリル。

    説明

    • プライマリゾーンディメンションのエラードリルシナリオでは、プライマリゾーン内のすべてのコンピュートノードが使用不可になり、このシナリオでのディザスタリカバリスイッチオーバーにはデータ損失が伴います。

    • ノードディメンションのエラードリルシナリオでは、単一のコンピュートノードのみをエラードリルできます。希望するコンピュートノード名を DBNodeCrashList で渡します。

    列挙値:

    • 0 :

      プライマリゾーンディメンションのエラードリル。

    • 1 :

      ノードディメンションのエラードリル。

    • FaultInjectToDbNode :

      ノードディメンションのエラードリル。

    • FaultInjectToPrimaryAz :

      プライマリゾーンディメンションのエラードリル。

    • FaultInjection :

      プライマリゾーンディメンションのエラードリル。

    0
    StorageAutoScale

    string

    任意

    Standard Edition クラスターの自動ストレージスケーリングを有効にするかどうかを指定します。有効な値:

    • Enable: 自動ストレージスケーリングを有効にします。

    • Disable: 自動ストレージスケーリングを無効にします。

    列挙値:

    • Enable :

      自動ストレージスケーリングを有効にします。

    • Disable :

      自動ストレージスケーリングを無効にします。

    Enable
    CompressStorage

    string

    任意

    ストレージ圧縮を有効にします。値を ON に設定します。

    ON
    StorageUpperBound

    integer

    任意

    Standard Edition クラスターの自動ストレージスケーリングの上限。単位: GB。

    説明

    最大値は 32000 です。

    800
    DBNodeCrashList

    string

    任意

    障害注入ノードインスタンス名のリスト。

    説明

    ノードディメンションの障害注入はシングルノードのみサポートしています。ゾーンディメンションの障害注入の場合、このパラメーターを省略するか、すべてのノードを渡せます。

    pi-rwxxx
    FaultInjectionType

    string

    任意

    障害注入のメソッド。有効な値:

    • 0: Crash SQL に基づくインスタンスの障害注入。

    列挙値:

    • CrashSQLInjection :

      CrashSQLInjection。

    0
    ImciAutoIndex

    string

    任意

    インメモリー列指向インデックスベースの自動クエリアクセラレーション特徴。有効な値:

    • ON: 有効。

    • OFF: 無効。

    説明

    列挙値:

    • OFF :

      OFF。

    • ON :

      ON

    OFF
    TableMeta

    string

    任意

    復元対象のデータベースとテーブル情報の JSON 文字列。データベースとテーブル情報の値はすべて文字列型です。 例: [ { "tables":[ { "name":"testtb", "type":"table", "newname":"testtb_restore" } ], "name":"testdb", "type":"db", "newname":"testdb_restore" } ]。

    説明

    DescribeMetaList 操作を呼び出して、復元をサポートするデータベース名とテーブル名の詳細を確認し、サポートされているデータベースとテーブルの情報を前述の例の対応する位置に塗りつぶします。

    [ { "tables":[ { "name":"testtb", "type":"table", "newname":"testtb_restore" } ], "name":"testdb", "type":"db", "newname":"testdb_restore" } ]
    ModifyRowCompression

    string

    任意

    行圧縮の設定項目を変更します。

    OFF
    ConnectionResourceQuota

    integer

    任意

    AgenticDB クラスターの接続リソースクォータ。

    StandbyHAMode、DataSyncMode、FaultSimulateMode、および StorageAutoScale パラメーターについては、呼び出しごとに 1 つのパラメーターのみ設定できます。たとえば、StandbyHAMode パラメーターを設定する場合、他のリクエストパラメーターを同時に設定できません。

    説明

    StorageAutoScale パラメーターを Enable に設定する場合、StorageUpperBound パラメーターも設定して、クラスターの自動ストレージスケーリングの上限を指定する必要があります。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答のスキーマ。

    RequestId

    string

    リクエストの ID。

    CD3FA5F3-FAF3-44CA-AFFF-BAF869******
    DBClusterId

    string

    クラスターの ID。

    pc-*************
    OrderId

    string

    生成された注文の ID。

    2148126708*****

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "CD3FA5F3-FAF3-44CA-AFFF-BAF869******",
  "DBClusterId": "pc-*************",
  "OrderId": "2148126708*****"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 OperationDenied.CreateDBNodesWithStrictConsistencyOn 3AZ cluster does not allow create db nodes. 3 ゾーンクラスターへのノードの追加は許可されていません。
    400 InvalidDBProxyClusterClass.Malformed The specified parameter DBProxyClusterClass is not valid. 指定された DBProxyClusterClass パラメーターは無効です。
    400 InvalidDBNodeNum.Malformed The number of parameter DBNode.N is not valid. DBNode パラメーターの数は無効です。
    400 OperationDenied.ModifyDBNodeClassWithStrictConsistencyOn 3AZ cluster does not allow modify db node class. 3 ゾーンクラスター内のロガーノードのノードスペックの変更は許可されていません。
    400 InvalidDowngradeDBNodeClass.Limit The specified Downgrade DBNodeClass is limit on the MaxDiskSize. DBNodeClass のスペックダウンは MaxDiskSize によって制限されています。
    400 InvalidEngine.Unsupported The specified Engine does not support this feature. 指定されたエンジンはこの特徴をサポートしていません。
    400 OperationDenied.ModifyProxyWithStrictConsistencyOn 3AZ cluster does not allow modify proxy. 3 ゾーンクラスターでは、データベースプロキシを変更できません。
    400 StandbyClusterTurnOn The specified dbCluster already turn on hot standby cluster. 指定された dbCluster では、既にホットスタンバイクラスターの読み取りが有効になっています。
    500 InternalError The request processing has failed due to some unknown error, exception or failure. 不明なエラー、例外、または障害により、リクエストの処理に失敗しました。
    403 IncorrectDBInstanceType Current DB instance type does not support this operation. 現在のデータベースインスタンスタイプでは、この操作に対応していません。
    403 IncorrectDBInstance Current DB instance does not support this operation. 現在のデータベースインスタンスでは、この操作に対応していません。
    403 OperationDenied.LockMode The operation is not permitted due to lock of cluster. インスタンスがロック済み状態であり、この操作がサポートされていないため、操作に失敗しました。
    403 OperationDenied.DBClusterStatus The operation is not permitted due to status of cluster. PolarDB クラスターの現在の状態では、この操作は許可されていません。
    403 OperationDenied.TempUpgradeDuring This operation is not allowed during the temporary upgrade of the cluster. クラスターの一時的なアップグレード中は、この操作は実行できません。
    403 InvalidParam.PgDBNodeSpec The specification PGO of DB nodes is incorrect. DB ノードの仕様 PGO が正しくありません。
    403 InvalidParam.NoChange No change found 変更点が見つかりませんでした。
    403 OperationDenied.DBNodeClass The target DB node class is invalid for SQL acceleration. 対象の DB ノードクラスは、SQL 高速化に対して無効です。
    403 OperationDenied.ReaderNum The target reader node number is invalid for SQL acceleration. SQL アクセラレーションのターゲット読み取りノード ID は無効です。
    403 InvalidParam.DBNodeNum The number of DB nodes is incorrect. データベースノードの数が正しくありません。
    403 OperationDenied.DBNodeRole The operation is not permitted due to the role of node. ノードのロールにより、この操作は許可されていません。
    403 OperationDenied.DeleteNode The senormal version cluster does not allow the deletion of ro nodes and standby nodes at the same time. SENormal エディションのクラスターでは、読み取り専用ノードとスタンバイノードの同時削除は許可されていません。
    403 OperationDenied.EndpointDBNodeNumber The operation is not permitted due to node number for Endpoint. このエンドポイントでは、この操作は許可されていません。
    403 OperationDenied.StandbyEqualSpec The spec of standby must be equal to rw スタンバイスペックは RW である必要があります。
    403 OperationDenied.DeleteDBNodeNumber The operation is not permitted due to the node number to delete. このノードの削除は許可されていません。
    403 OperationDenied.DbVersion The operation is not permitted due to DbVersion. データベースエンジンのバージョンにより、この操作は許可されていません。
    403 OperationDenied.ClusterCategory The operation is not permitted due to cluster category. このクラスターでは、このプロダクトシリーズはサポートされていません。
    403 OperationDenied.clusterSingleNodeLimit Single-node instances are not supported and need to be upgraded to cluster version シングルノードインスタンスはサポートされていません。インスタンスを Cluster Edition にアップグレードしてください。
    403 InvalidParam.CRACParamNodeNum The CRAC nodes cannot exceed 8. CRAC ノードの数は 8 を超えることはできません。
    403 InvalidParam.ECSESSDSTANDARDParamNodeNum The ECSESSDSTANDARD nodes cannot exceed 8. ECESSDSTANDARD ノードの数は 8 を超えることはできません。
    404 InvalidParam Invalid Parameter.
    404 InvalidEditType Wrong upgrade type. スペックアップタイプは無効です。

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

    変更履歴

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