すべてのプロダクト
Search
ドキュメントセンター

:ModifyDBClusterParameters

最終更新日:Dec 11, 2025

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

*dbcluster

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

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

DBClusterId

string

必須

クラスター ID。

説明

DescribeDBClusters 操作を呼び出して、ターゲットリージョン内のすべてのクラスター (クラスター ID を含む) に関する情報を表示できます。

pc-**************

Parameters

string

任意

パラメーターとその値で構成される JSON 文字列。パラメーター値は文字列である必要があります。例:{"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 を指定し、このパラメーターを指定しない場合、タスクを開始する最も遅い時刻は、デフォルトで PlannedStartTime + 30 分 になります。たとえば、PlannedStartTime2021-01-14T09:00:00Z に設定し、このパラメーターを空のままにすると、タスクは 2021-01-14T09:30:00Z までに開始されます。

2022-04-28T14:30:00Z

FromTimeService

boolean

任意

パラメーターをすぐに変更してクラスターを再起動するかどうかを指定します。有効値:

  • false (デフォルト):変更はスケジュールされます。

  • true:変更はすぐに実行されます。

false

レスポンスフィールド

フィールド

説明

object

RequestId

string

リクエスト ID。

C5D526E5-91B5-48B8-B980-FE07FF******

成功レスポンス

JSONJSON

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

エラーレスポンス

JSONJSON

{
  "RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC"
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 InvalidParameters.Format Specified parameters is not valid.
400 MinorVersionNotSupport Custins minor version does not support current action.
400 ParamDynamicException Conflicting parameters: %s
400 InvalidParameters.Malformed The Specified parameters is not valid.
400 InvalidParameter.Malformed Choose one of parameters and ParamGroupId.
404 InvalidDBClusterId.NotFound The DBClusterId provided does not exist in our records.
404 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid.

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

変更履歴

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