本文へジャンプします。

ニフクラ APIリファレンス

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

RDB: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 DBパラメーターグループ名 文字列  
Parameters.Parameter.N.ApplyMethod

パラメーターの適用方法

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

値:immediate(今すぐ) | pending-reboot(再起動待ち)

文字列  
Parameters.Parameter.N.ParameterName 変更するパラメーターの名前
  • ※1回のリクエストで最大20個のパラメーターを変更可能です
文字列  
Parameters.Parameter.N.ParameterValue 変更するパラメーターの名前
  • ※1回のリクエストで最大20個のパラメーターを変更可能です
文字列  

レスポンス

XML

status

statusは共通の応答メッセージを返却します。

result
要素名 説明 備考
ModifyDBParameterGroupResponse ルート  
ModifyDBParameterGroupResult 結果  
DBParameterGroupName DBパラメーターグループ名 文字列  
ResponseMetadata 共通メタ情報  

エラー

コード メッセージ タイプ 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 Invalid parameter group name: sample@parameter 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を指定しなかった場合
The parameter basedir cannot be modified. Sender 400 エンジンに指定できないParameterNameを指定した場合
Value: 100000000 is outside of range: 0-100000 Sender 400 Integer型またはFloat型のパラメータに範囲外の値を指定した場合
Invalid boolean value: aaa Sender 400 Boolean型パラメータに0,1以外を指定した場合
invalid parameter value, allowed values are:OFF,ON,ALL Sender 400 Stiring型パラメータに指定文字列以外を入力した場合
value does not match pattern Sender 400 DBパラメーター式変数の形式が不正な場合
Invalid parameter value: 11111-2222-3333. Sender 400 Integer型パラメータに無効な値を指定した場合
invalid float value:11111-2222-3333 Sender 400 Float型パラメータに無効な値を指定した場合
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 Invalid parameter group name: sample-prameter12345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890 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://rdb.jp-east-1.api.cloud.nifty.com/
  ?Action=ModifyDBParameterGroup
  &DBParameterGroupName=mydbparametergroup
  &Parameters.Parameter.1.ApplyMethod=pending-reboot
  &Parameters.Parameter.1.ParameterName=max_connections
  &Parameters.Parameter.1.ParameterValue=24
  &Parameters.Parameter.2.ApplyMethod=immediate
  &Parameters.Parameter.2.ParameterName=max_allowed_packet
  &Parameters.Parameter.2.ParameterValue=1024
  &SignatureVersion=2
  &SignatureMethod=HmacSHA256
  &Timestamp=2013-12-09T00%3A00%3A00.000Z
  &AWSAccessKeyId=<Nifty Cloud Access Key ID>
  &Signature=<Signature>
レスポンスサンプル

API リクエスト正常終了時

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<ModifyDBParameterGroupResponse>
  <ModifyDBParameterGroupResult>
   <DBParameterGroupName>mydbparametergroup</DBParameterGroupName>
  </ModifyDBParameterGroupResult>
  <ResponseMetadata>
   <RequestId>a0b43aa9-e057-41ce-9765-3628f08ea320</RequestId>
  </ResponseMetadata>
</ModifyDBParameterGroupResponse>

指定したパラメータ値に無効な値が含まれていた場合

<ErrorResponse>
 <Error>
   <Type>Sender</Type>
   <Code>InvalidParameterValue</Code>
   <Message>DBParameterGroup parameter value is invalid.</Message>
   <NiftyErrorParameters>
     <NiftyErrorParameter>
       <NiftyParameterName>local_infile</ParameterName>
       <NiftyMessage>Invalid boolean value: 3</Message>
     </NiftyErrorParameter>
     <NiftyErrorParameter>
       <NiftyParameterName>connect_timeout</ParameterName>
       <NiftyMessage>Value: 1 is outside of range: 2-31536000</Message>
     </NiftyErrorParameter>
   </NiftyErrorParameters>
 </Error>
 <RequestId>3213af08-092a-45c6-91a1-7f6b5599dd17</RequestId>
</ErrorResponse>

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