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

PolarDB:ModifyDBClusterParameters

最終更新日:Feb 20, 2025

この API を呼び出して、指定した ApsaraDB for PolarDB クラスターのパラメーターを変更できます。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 OpenAPI Explorer を使用すると、API を簡単に設定できます。 OpenAPI Explorer は、各種 SDK 用のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター

必須項目

説明

DBClusterId

String

はい

pc-xxxxxxxxxx

クラスターの ID。

Parameters

String

はい

{"auto_increment":"1","character_set_client":"utf8"}

パラメーターとその値で構成される JSON 文字列。 パラメーター値は文字列です。{"auto_increment":"1","character_set_client":"utf8"}

説明

DescribeDBClusterParameters 操作を呼び出すと、ApsaraDB for PolarDB クラスターのパラメーターを表示できます。

AccessKeyId

String

いいえ

key-test

Alibaba Cloud から提供された AccessKey ID。

Action

String

いいえ

ModifyDBClusterParameters

実行する操作。 この値を ModifyDBClusterParameters に設定します。

EffectiveTime

String

いいえ

Auto

変更したパラメーター値が有効になる時間。 設定可能な値は以下のとおりです。

  • Auto:システムは、パラメーターの変更された値がどのように有効になるかを自動的に決定します。 すべての変更したパラメーター値がクラスターの再起動に関係なく有効になる場合、パラメーター値はすぐに有効になります。 変更したパラメーター値の一部を有効にするためにクラスターの再起動が必要な場合は、メンテナンスウィンドウ内でクラスターを再起動した後にすべてのパラメーターが有効になります。

  • Immediately:すべての変更したパラメーター値がクラスターの再起動に関係なく有効になる場合、パラメーター値はすぐに有効になります。 変更したパラメーター値の一部を有効にするためにクラスターの再起動が必要な場合は、クラスターをすぐに再起動してすべてのパラメーターを有効にします。

  • MaintainTime:変更したパラメーター値は、メンテナンスウィンドウ内で有効になります。 変更したパラメーター値を有効にするためにクラスターの再起動が必要かどうかに関係なく、すべてのパラメーター値がメンテナンスウィンドウ内で有効になります。

デフォルト値:Auto

レスポンスパラメーター

パラメーター

説明

RequestId

String

D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC

リクエストの ID。

リクエストの例


http(s)://[Endpoint]/? Action=ModifyDBClusterParameters
&DBClusterId=pc-xxxxxxxxxx
&Parameters={"auto_increment":"1","character_set_client":"utf8"}
&<共通リクエストパラメーター>

通常のレスポンス例

XML 形式

<ModifyDBClusterParametersResponse>  
	  <RequestId>D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC</RequestId>
</ModifyDBClusterParametersResponse>

JSON 形式

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

エラーコード

エラーコードのリストについては、「API エラーセンター」をご参照ください。