本文へジャンプします。

ニフクラ ユーザーガイド

クラウド トップ>API> RDB> ModifyDBParameterGroup

ModifyDBParameterGroup

処理概要

DBパラメーターグループのパラメーターを更新します。

最大20個のDBパラメーターを1回のリクエストで変更できます。

適用方法にはapply-immediate(今すぐ)とpending-reboot(再起動待ち)の2種類があります。

apply-immediateはdynamicパラメーターにのみ利用できます。
pending-rebootはMySQL、PostgreSQLエンジンの場合はdynamic・static両方のパラメーターに利用できます。

PostgreSQL エンジンの場合、pending-rebootを指定しても、dynamicパラメーターは即時反映(apply-immediateと同じ動作)になります。

指定するパラメーター

パラメーター 説明 必須
DBParameterGroupName string DBパラメーターグループ名
Parameters.member.N.ApplyMethod string

パラメーターの適用方法

  • ※MySQL、PostgreSQLの場合、下記のようなルールが存在します
    • “immediate”はdynamicなパラメーターにのみ指定可能
    • “pending-reboot”はdynamic・static両方のパラメーターに指定可能
  • ※1回のリクエストで最大20個のパラメーターを変更可能です

値:
  • immediate (今すぐ)
  • pending-reboot (再起動待ち)
Parameters.member.N.ParameterName string

変更するパラメーターの名前

  • ※1回のリクエストで最大20個のパラメーターを変更可能です

Parameters.member.N.ParameterValue string

パラメーターに適用する値

  • ※1回のリクエストで最大20個のパラメーターを変更可能です

応答フィールド

フィールド (項目) 説明
ModifyDBParameterGroupResponse structure ルート
ModifyDBParameterGroupResult structure 結果
DBParameterGroupName string DBパラメーターグループ名
ResponseMetadata structure 共通メタ情報
RequestId string リクエスト識別子

エラー

コード メッセージ タイプ HTTPステータスコード 説明
Client.InvalidParameterCannotSpecify.ApplyMethod

cannot use immediate apply method for static parameter

Sender 400 Staticパラメーターの変更でApplyMethodをimmediateに指定した場合
Client.InvalidParameterDuplicate.ParameterName

Duplicate parameters specified in the same call

Sender 400 変更するパラメータが重複している場合
Client.InvalidParameterFormat.DBParameterGroupName

The parameter DBParameterGroupName is not a valid identifier.Identifiers must begin with a letter; must contain only lowercase ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.

Sender 400 DBParameterGroupNameに無効な値(ハイフンから始まる 等)を指定した場合
Client.InvalidParameterIllegalInput.ApplyMethod

ApplyMethod can be either immediate or pending-reboot but not:aaa

Sender 400 ApplyMethodに無効な値を指定した場合
Client.InvalidParameterIllegalInput.ParameterValue

Parameter value cannot be empty: binlog_max_flush_queue_time

Sender 400 必須のParameterValueを指定しなかった場合
Client.InvalidParameterIllegalInput.ParameterValue

The parameter basedir cannot be modified.

Sender 400 エンジンに指定できないParameterNameを指定した場合
Client.InvalidParameterIllegalInput.ParameterValue

Value: 100000000 is outside of range: 0-100000

Sender 400 Integer型またはFloat型のパラメータに範囲外の値を指定した場合
Client.InvalidParameterIllegalInput.ParameterValue

Invalid boolean value: aaa

Sender 400 Boolean型パラメータに0,1以外を指定した場合
Client.InvalidParameterIllegalInput.ParameterValue

invalid parameter value, allowed values are:OFF,ON,ALL

Sender 400 Stiring型パラメータに指定文字列以外を入力した場合
Client.InvalidParameterIllegalInput.ParameterValue

value does not match pattern

Sender 400 DBパラメーター式変数の形式が不正な場合
Client.InvalidParameterIllegalInput.ParameterValue

Invalid parameter value: 11111-2222-3333.

Sender 400 Integer型パラメータに無効な値を指定した場合
Client.InvalidParameterIllegalInput.ParameterValue

invalid float value:11111-2222-3333

Sender 400 Float型パラメータに無効な値を指定した場合
Client.InvalidParameterIllegalInput.ParameterValue

Empty value found in 111,,222 for parameter aaa

Sender 400 List型パラメーターに空文字を含めた場合
Client.InvalidParameterIllegalInput.ParameterValue

invalid parameter value list, allowed values are:OFF,ON,ALL

Sender 400 List型パラメーターに指定文字列以外を入力した場合
Client.InvalidParameterIllegalInput.ParameterValue

Duplicate parameter values specified in 111,111 for parameter aaa

Sender 400 List型パラメーターに重複する値を指定した場合
Client.InvalidParameterNotAllowed.DefaultDBParameterGroup

Cannot modify a default parameter group.

Sender 400 "default."で始まるデフォルトのDBパラメーターグループを指定した場合
Client.InvalidParameterNotAllowed.PostgresParameterCannotModify

DBParameterGroup sample-parameter cannot be modified because it is associated with read replicas.

Sender 400 postgresでリードレプリカをもつDBパラメーターグループに対して、変更不可のパラメータ(max_connections,max_prepared_transactions,max_locks_per_transaction)を変更しようとした場合
Client.InvalidParameterNotFound.DBParameterGroup

DBParameterGroup not found: aaa

Sender 404 存在しないDBParameterGroupNameを指定した場合
Client.InvalidParameterNotFound.ParameterName

Could not find parameter with name: aaa

Sender 400 存在しないParameterNameを指定した場合
Client.InvalidParameterRequired.ApplyMethod

ApplyMethod is required

Sender 400 必須のApplyMethodを指定しなかった場合
Client.InvalidParameterRequired.DBParameterGroupName

DBParameterGroupName is required.

Sender 400 必須のDBParameterGroupNameを指定しなかった場合
Client.InvalidParameterRequired.ParameterName

Parameter name cannot be empty

Sender 400 必須のParameterNameを指定しなかった場合
Client.InvalidParameterTooLong.DBParameterGroupName

The parameter DBParameterGroupName is not a valid identifier because it is longer than 255 characters.

Sender 400 DBParameterGroupNameに255文字を超える値を指定した場合
Client.InvalidParameterTooManyItem.Parameters

Cannot modify more than 20 parameters in a single request

Sender 400 20個を超えるパラメータを変更しようとした場合
Client.ResourceIncorrectState.DBInstanceUsingDBParameterGroup.Processing

Cannot modify the DBParameterGroup because DBInstance using the DBParameterGroup is modifying or rebooting.

Sender 400 DBパラメーターグループを使用しているDBサーバーのステータスが「modifying」または「rebooting」の場合

リクエストサンプル

    https://jp-east-1.rdb.api.nifcloud.com/
  ?Action=ModifyDBParameterGroup
  &DBParameterGroupName=mydbparametergroup
  &Parameters.member.1.ApplyMethod=pending-reboot
  &Parameters.member.1.ParameterName=max_connections
  &Parameters.member.1.ParameterValue=24
  &Parameters.member.2.ApplyMethod=immediate
  &Parameters.member.2.ParameterName=max_allowed_packet
  &Parameters.member.2.ParameterValue=1024
  &SignatureVersion=2
  &SignatureMethod=HmacSHA256
  &Timestamp=2013-12-09T00:00:00.000Z
  &AWSAccessKeyId=<NIFCLOUD Access Key ID>
  &Signature=<Signature>

  

応答サンプル

    <ModifyDBParameterGroupResponse>
  <ModifyDBParameterGroupResult>
   <DBParameterGroupName>mydbparametergroup</DBParameterGroupName>
  </ModifyDBParameterGroupResult>
  <ResponseMetadata>
   <RequestId>a0b43aa9-e057-41ce-9765-3628f08ea320</RequestId>
  </ResponseMetadata>
</ModifyDBParameterGroupResponse> 

  
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2021年9月13日時点の情報です。

推奨画面サイズ 1024×768 以上