API を介したクラスターとノードのパラメーター変更 - PolarDB - Alibaba Cloud - PolarDB

クラスターのパラメーターを変更し、指定したノードに適用します。

今すぐお試しください

この 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:ModifyDBClusterAndNodesParameters

update

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスター ID。	pc-**********
DBNodeIds	string	任意	ノードの ID。このパラメーターを設定することで、クラスターおよび指定されたノードのパラメーターを変更できます。複数のノード ID はコンマ (,) で区切ります。説明このパラメーターを指定しない場合、クラスターのパラメーターのみが変更されます。	pi-********,pi-********
Parameters	string	任意	パラメーターとその値で構成される JSON 文字列。	{"wait_timeout":"86","innodb_old_blocks_time":"10"}
ParameterGroupId	string	任意	パラメータテンプレートの ID。	pcpg-**********
PlannedStartTime	string	任意	定期タスクを開始する最も早い時刻。時刻は `YYYY-MM-DDThh:mm:ssZ` の形式で指定します。時刻は協定世界時 (UTC) である必要があります。説明開始時刻は、今後 24 時間以内の任意の時刻に設定できます。たとえば、現在の時刻が `2021-01-14T09:00:00Z` の場合、`2021-01-14T09:00:00Z` から `2021-01-15T09:00:00Z` までの範囲で時刻を指定できます。このパラメーターを空のままにすると、タスクはすぐに実行されます。	2021-01-14T09:00:00Z
PlannedEndTime	string	任意	定期タスクを開始する最も遅い時刻。時刻は `YYYY-MM-DDThh:mm:ssZ` の形式で指定します。時刻は協定世界時 (UTC) である必要があります。説明最も遅い開始時刻は、最も早い開始時刻より 30 分以上遅らせる必要があります。 `PlannedStartTime` を指定し、このパラメーターを指定しない場合、タスクの最も遅い開始時刻は、デフォルトで `最も早い開始時刻 + 30 分` になります。たとえば、`PlannedStartTime` を `2021-01-14T09:00:00Z` に設定し、このパラメーターを空のままにすると、タスクは `2021-01-14T09:30:00Z` までに開始されます。	2021-01-14T09:30:00Z
FromTimeService	boolean	任意	パラメーターの変更とクラスターの再起動をすぐに実行するか、スケジュールに従って実行するかを指定します。有効な値： false (デフォルト): スケジュールされた実行 true: 即時実行	false
ClearBinlog	boolean	任意	バイナリログをクリアするかどうかを指定します。このパラメーターは、バイナリログが無効になっている場合にのみ有効です。
StandbyClusterIdListNeedToSync	string	任意	パラメーター設定を同期する GDN スタンバイクラスターのリスト。	gdn-********,gdn-********

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID。	9B7BFB11-C077-4FE3-B051-F69CEB******

例

成功レスポンス

JSONJSON

{
  "RequestId": "9B7BFB11-C077-4FE3-B051-F69CEB******"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidParameters.Format	Specified parameters is not valid.
400	InvalidDBType.Malformed	The Specified DBType is not valid.
400	ParamCollationServerNotValid	This param collation_server is not valid.
400	MinorVersionNotSupport	Custins minor version does not support current action.
400	ScheduleTaskExist	The specified dbCluster already has a scheduled task.
400	ParamTypeException	Param is isClusterAvailable, not allow to change alone
400	ParamDynamicException	Conflicting parameters: %s
400	InvalidParameterGroupId.Malformed	The Specified parameter ParameterGroupId is not valid.
400	InvalidParameters.Malformed	The Specified parameters is not valid.
400	InvalidParameter.Malformed	Choose one of parameters and ParamGroupId.
404	InvalidDBCluster.NotFound	The specified DBClusterId is not found.
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.
404	InvalidDBNodeId.NotFound	The DBNodeId provided does not exist in our records.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.

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

変更履歴

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