API による PolarDB MySQL クラスター設定の変更 - PolarDB - Alibaba Cloud - PolarDB

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
StorageAutoScale	string	任意	Standard Edition クラスターのストレージ自動スケーリングを有効にするかどうかを指定します。有効な値: 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`: 無効。説明 PolarDB for MySQL クラスターのみがサポートされます。クラスターバージョンの要件については、自動アクセラレーション (AutoIndex) を参照してください。列挙値: 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

1 回の呼び出しにつき、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 ゾーンクラスターの logger ノードのノードスペックの変更は許可されていません。
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.	ソース ApsaraDB RDS インスタンスの現在のステータスではこの操作を実行できません。
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 アクセラレーションのターゲット読み取りノード数が無効です。
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.	DB バージョンのため、この操作は許可されていません。
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.	スペックアップタイプが無効です。

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

変更履歴

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