ModifyDBClusterParameters API で PolarDB クラスターパラメータを更新する - PolarDB - Alibaba Cloud - PolarDB

操作説明

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:ModifyDBClusterParameters

update

*クラスター

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスターの ID。説明 DescribeDBClusters 操作を呼び出して、指定されたリージョン内のすべてのクラスターに関する情報（クラスター ID を含む）をクエリできます。	pc-**************
Parameters	string	任意	パラメーターとその値で構成される JSON 文字列。パラメーター値は STRING 型です。例: `{"wait_timeout":"86","innodb_old_blocks_time":"10"}`。説明 DescribeDBClusterParameters 操作を呼び出して、PolarDB クラスターのパラメーターをクエリできます。クラスターが PolarDB for PostgreSQL または PolarDB for PostgreSQL (Oracle 互換) を実行している場合、このパラメーターは必須です。クラスターが PolarDB for MySQL を実行している場合、このパラメーターまたは `ParameterGroupId` パラメーターのいずれかを指定する必要があります。	{"wait_timeout":"86","innodb_old_blocks_time":"10"}
ParameterGroupId	string	任意	パラメータテンプレートの ID。説明 DescribeParameterGroups 操作を呼び出して、パラメータテンプレートの ID をクエリできます。このパラメーターまたは `Parameters` パラメーターのいずれかを指定する必要があります。このパラメーターは PolarDB for MySQL のみでサポートされています。	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` までです。このパラメーターが空の場合、タスクはすぐに実行されます。	2022-04-28T14:00:00Z
PlannedEndTime	string	任意	定期タスクの実行を開始する最も遅い時刻。時刻は `YYYY-MM-DDThh:mm:ssZ` フォーマット (協定世界時 (UTC)) です。説明最も遅い時刻は、開始時刻から少なくとも 30 分後である必要があります。 `PlannedStartTime` を指定したがこのパラメーターを指定しない場合、最も遅い時刻はデフォルトで「開始時刻 + 30 分」となります。たとえば、`PlannedStartTime` が `2021-01-14T09:00:00Z` にセットされ、このパラメーターが空の場合、タスクは `2021-01-14T09:30:00Z` までにスケジュールされます。	2022-04-28T14:30:00Z
FromTimeService	boolean	任意	パラメーターの変更とクラスターの再起動を即時実行するかスケジュール実行するかを指定します。有効な値: false (デフォルト): スケジュール実行。 true: 即時実行。	false
ClearBinlog	boolean	任意	バイナリログをクリアするかどうかを指定します。このパラメーターはバイナリロギングが無効な場合にのみ効果があります。

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	C5D526E5-91B5-48B8-B980-FE07FF******

例

成功レスポンス

JSONJSON

{
  "RequestId": "C5D526E5-91B5-48B8-B980-FE07FF******"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParameters.Format	Specified parameters is not valid.	パラメーターが正しくありません。
400	MinorVersionNotSupport	Custins minor version does not support current action.	現在のマイナーバージョンではこの機能はサポートされていません。まず最新バージョンにアップグレードしてください。
400	ParamDynamicException	Conflicting parameters: %s	インスタンスのカーネルパラメーターと現在変更済みのパラメーターに同じプロンプトがあるかどうかを確認してください: %s。
400	InvalidParameters.Malformed	The Specified parameters is not valid.	指定されたパラメーターが無効です。
400	InvalidParameter.Malformed	Choose one of parameters and ParamGroupId.	パラメーターから ParamGroupId を選択してください。
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.	指定された DBClusterId が現在のレコードに存在しません。
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	指定された DBClusterId がレコードに存在しません。

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

変更履歴

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