本文へジャンプします。

ニフティクラウド 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.member.N

パラメーターリスト

  • ※1回のリクエストで最大20個のパラメーターを変更可能です
リスト  
ApplyMethod パラメーターの適用方法
値:immediate(今すぐ) | pending-reboot(再起動待ち)
文字列  
ParameterName 変更するパラメーターの名前 文字列  
ParameterValue パラメーターに適用する値 文字列  

レスポンス

XML

status

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

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

エラー

コード メッセージ タイプ HTTP
ステータスコード
説明
DBParameterGroupNotFound Parameter group does not exist Sender 404 存在しないDBParameterGroupNameを指定した場合
InvalidDBParameterGroupState The DB Parameter Group cannot be deleted because it is in use. Sender 400 DBパラメーターグループのステータスが有効でない場合(変更中など)
InvalidParameterCombination cannot use immediate apply method for static parameter Sender 400 Staticパラメーターの変更でApplyMethodをimmediateに指定した場合
Cannot modify more than 20 parameters in a single request Sender 400 変更するパラメーターを20個以上指定した場合
InvalidParameterValue ApplyMethod is required Sender 400 ApplyMethodを指定しなかった場合
ApplyMethod can be either immediate or pending-reboot but not:reboot Sender 400 ApplyMethodに無効な値を指定した場合
Could not find parameter with name: aaaaaa Sender 400 ParameterNameに存在しないパラメーター名を指定した場合
Parameter name cannot be empty Sender 400 ParameterNameを指定しなかった場合
Parameter value cannot be empty: flush_time Sender 400 ParameterValueを指定しなかった場合
The parameter {0} cannot be modified. Sender 400 エンジンに指定できないParameterNameを指定した場合
Value: a is outside of range: 1-65535 Sender 400 パラメーターのValueに設定できる範囲を超えた場合
Duplicate parameters specified in the same call Sender 400 変更するパラメーターが重複している場合
Invalid boolean value: a Sender 400 真偽値のパラメーターに1と0以外の数値を入力した場合
Cannot modify a default parameter group Sender 400 DBParameterGroupName にデフォルトのパラメーターグループを指定した場合
invalid parameter value, allowed values are:{0} Sender 400 Stiringパラメーターに指定文字列以外を入力した場合
Invalid parameter group name: {0} Sender 400 DBParameterGroupNameに無効な(数字から始まるなど)値を指定した場合
value does not match pattern Sender 400 ユーザー指定不可などの無効な値のパラメーター変数を指定した場合

サンプル

リクエストサンプル
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 以上