ModifyParameter操作を呼び出して、インスタンスのパラメーターを変更できます。

パラメーターは、直接、またはパラメーターテンプレートを使用して変更できます。 パラメータ変更リクエストを送信すると、ApsaraDB RDSは新しいパラメータ値をインスタンスに適用するタスクを開始します。 新しいパラメーター値がインスタンスの再起動後にのみ有効になる場合、ApsaraDB RDSはインスタンスを再起動します。 設定可能なパラメーターについては、「ApsaraDB RDS For MySQLインスタンスのパラメーターの設定」をご参照ください。

説明 ApsaraDB RDSは、パラメーター変更タスクを実行する前に、パラメーターが存在するかどうか、設定可能かどうか、および新しいパラメーター値が有効かどうかを確認します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

項目 データ型 必須／任意 例: 説明　
操作 String 必須 ModifyParameter

実行する操作です。 値をModifyParameterに設定します。

ClientToken String 任意 ETnLKlblzczshOTUbOCzxxxxxxxxxx

リクエストのべき等性を保証するために使用されるクライアントトークン。 クライアントを使用して値を生成できますが、生成されたトークンが異なるリクエスト間で一意であることを確認する必要があります。 トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。

DBInstanceId String 必須 rm-uf6wjk5xxxxxxx

インスタンスの ID です。

パラメーター String 必須 {"delayed_insert_timeout":"600","max_length_for_sort_data":"2048"}

パラメーターとその値のJSON文字列。 すべてのパラメーター値は文字列型です。 フォーマット: {"Parameter name 1":"Parameter value 1","Parameter name 2":"Parameter value 2"...} DescribeParameterTemplates操作を呼び出して、パラメーター名と値を照会できます。

説明 このパラメーターを指定する場合、 ParameterGroupIdパラメーターを指定する必要はありません。
Forcerestart Boolean いいえ false

新しいパラメーター値を有効にするためにインスタンスを再起動するかどうかを指定します。 有効な値：

  • true: システムが強制的にインスタンスを再起動します。 インスタンスの再起動後に新しいパラメーター値が有効になる場合は、このパラメーターをtrueに設定する必要があります。 それ以外の場合、新しいパラメーター値は有効になりません。
  • false: システムがインスタンスを強制的に再起動しません。

デフォルト値：false

ParameterGroupId String 任意 rpg-xxxxxxxxx

パラメーターテンプレートのID。

説明
  • このパラメーターを指定する場合、Parametersパラメーターを指定する必要はありません。
  • インスタンスの再起動後にのみパラメーターテンプレートを適用できる場合は、Forcerstartパラメーターを指定する必要があります。
SwitchTimeMode String 任意 ScheduleTime

変更が有効になる時刻。 有効な値：

  • すぐに: すぐにパラメーターを変更します。 デフォルト値です。
  • MaintainTime: インスタンスのメンテナンス期間中にパラメーターを変更します。 ModifyDBInstanceMaintainTime操作を呼び出して、インスタンスのメンテナンス期間を変更できます。
  • ScheduleTime: 変更は、指定した時点で有効になります。 この値を指定する場合は、SwitchTimeパラメーターも指定する必要があります。
SwitchTime String 任意 2022-05-06T09:24:00Z

変更が有効になる時刻。 yyyy-MM-dd T HH:mm:ss Z形式のISO 8601標準で時刻を指定します。 時間は UTC にする必要があります。

説明 この時間は、この操作を呼び出す時間より後でなければなりません。

レスポンスパラメーター

項目 データ型 例: 説明　
RequestId String 542BB8D6-4268-45CC-A557-B03EFD7AB30A

リクエストの ID です。

例

リクエストの例

http(s):// rds.aliyuncs.com/?Action=ModifyParameter
&DBInstanceId=rm-uf6wjk5xxxxxxx
&パラメーター={"delayed_insert_timeout":"600","max_length_for_sort_data":"2048"}
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyParameterResponse>
       <RequestId>542BB8D6-4268-45CC-A557-B03EFD7AB30A</RequestId>
</ModifyParameterResponse>

JSON 形式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "542BB8D6-4268-45CC-A557-B03EFD7AB30A"
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明　
400 PendingActionOverdue アクションの実行時間がすでに遅れている 変更を有効にするために指定した時間が経過した場合に返されるエラーメッセージ。
400 InvalidParameters. フォーマット 指定されたパラメーターは無効です。 指定されたパラメーターの値が無効な場合に返されるエラーメッセージ。
400 InvalidParameters. フォーマット 指定されたパラメーターの形式が無効です。 指定されたパラメーターの形式が無効な場合に返されるエラーメッセージ。
400 無効な. ParamGroupDBCategory ParamGroupカテゴリは標準ではなく基本です。 指定されたパラメーターテンプレートのカテゴリが標準ではなく基本である場合に返されるエラーメッセージ。
403 IncorrectDBInstanceType 現在のデータベースインスタンスタイプは、この操作をサポートしていません。 インスタンスの設定がこの操作をサポートしていない場合に返されるエラーメッセージ。
403 IncorrectDBInstanceState 現在のデータベースステータスは操作をサポートしていません。 インスタンスのステータスがこの操作をサポートしていない場合に返されるエラーメッセージ。 インスタンスが [実行中] 状態であることを確認します。
403 無効です。パラメーター 指定されたパラメーターは無効です。 指定されたパラメーターが無効な場合に返されるエラーメッセージ。
404 InvalidDBInstance.NotFound 指定されたインスタンスが存在しないか、サポートされていません。 指定されたインスタンスが見つからない場合に返されるエラーメッセージ。 インスタンスのIDを確認します。

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