本文へジャンプします。

ニフクラ APIリファレンス

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

RDB:ResetDBParameterGroup

処理概要

DBパラメーターグループのパラメーターをデフォルト値にリセットします。

特定のパラメーターをリセットするにはParameterName(パラメーター名)とApplyMethod(適用方法)を指定します。

すべてのパラメーターをリセットするには、DBParameterGroupName(DBパラメーターグループ名)とResetAllParameters(すべてのパラメータをリセットするフラグ)を指定します。

すべてのパラメーターをリセットする場合、dynamicパラメーターはただちに適用されますが、staticパラメーターはステータスがpending-reboot(再起動待ち)に変わり、DBサーバーが再起動されるかRebootInstanceアクションが呼び出されたときに適用が行われます。

リクエストパラメーター

要素名 説明 必須 最大値 デフォルト値 備考
DBParameterGroupName DBパラメーターグループ名 文字列  
Parameters.Parameter.N.ApplyMethod

パラメーターの適用方法

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

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

○(ResetAllParametersを指定しない場合) 文字列  
Parameters.Parameter.N.ParameterName リセットするパラメーターの名前
  • ※ResetAllParametersと同時に指定することはできません
  • ※1回のリクエストで最大20個のパラメーターをリセット可能です
○(ResetAllParametersを指定しない場合) 文字列  
ResetAllParameters

すべてのパラメーター値をデフォルト値に戻すかどうか

  • ※Parameters.member.Nと同時に指定することはできません
○(Parameters.member.Nを指定しない場合) 真偽値  

レスポンス

XML

status

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

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

エラー

コード メッセージ タイプ HTTP
ステータスコード
説明
Client.InvalidParameterCannotSpecify.ApplyMethod The parameter 'character-set-client-handshake' cannot be reset with an ApplyMethod of Immediate because it is a static parameter. Please specify an ApplyMethod of PendingReboot for this parameter. Sender 400 Staticパラメーターの変更でApplyMethodをimmediateに指定した場合
Client.InvalidParameterCombination.Parameters.and.ResetAllParameters May not specify both ResetAllParameters and a list of parameters to reset. Sender 400 Parameters.member.Nでパラメータを指定した時、ResetAllParametersにtrueを指定した場合
Client.InvalidParameterDuplicate.ParameterName Duplicate parameter found: binlog_max_flush_queue_time Sender 400 リセットするパラメータが重複している場合
Client.InvalidParameterEitherOf.Parameters.or.ResetAllParameters Must specify either ResetAllParameters or a list of parameters to reset. Sender 400 Parameters.member.NもResetAllParametersも指定しなかった場合
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:reboot Sender 400 ApplyMethodに無効な値を指定した場合
Client.InvalidParameterMissing.ApplyMethod Invalid ApplyMethod: null. Allowed values are: pending-reboot, immediate Sender 400 ResetAllParameters=falseの時、ApplyMethodを指定しなかった場合
Client.InvalidParameterMissing.ParameterName Invalid ParameterName: null. Sender 400 ResetAllParameters=falseの時、ParameterNameを指定しなかった場合
Client.InvalidParameterNotAllowed.PostgresParameterCannotModify DBParameterGroup sample-parameter cannot be reset because it is associated with read replicas. Sender 400
  • postgresでリードレプリカをもつDBパラメーターグループに対して変更不可のパラメータ(max_connections,max_prepared_transactions,max_locks_per_transaction)を変更しようとした場合
  • postgresでリードレプリカをもつDBパラメーターグループに対してResetAllParametersにTrueを指定しようとした場合
Client.InvalidParameterNotFound.DBParameterGroup DBParameterGroup not found: aaa Sender 404 存在しないDBParameterGroupNameを指定した場合
Client.InvalidParameterNotFound.ParameterName The following parameters are not defined for the specified group: aaa Sender 400 ResetAllParameters=falseの時、ParameterNameを指定した場合
Client.InvalidParameterRequired.DBParameterGroupName The parameter DBParameterGroupName must be provided and must not be blank. Sender 400 必須のDBParameterGroupNameを指定しなかった場合
Client.InvalidParameterTooLong.DBParameterGroupName The parameter DBParameterGroupName is not a valid identifier because it is longer than 255 characters. Sender 400 DBParameterGroupNameに255文字を超える値を指定した場合
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=ResetDBParameterGroup
    &DBParameterGroupName=mydbparametergroup
    &ResetAllParameters=true
    &SignatureVersion=2
    &SignatureMethod=HmacSHA256
    &Timestamp=2013-12-09T00%3A00%3A00.000Z
    &AWSAccessKeyId=<Nifty Cloud Access Key ID>
    &Signature=<Signature>
レスポンスサンプル
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<ResetDBParameterGroupResponse>
  <ResetDBParameterGroupResult>
  <DBParameterGroupName>mydbparametergroup</DBParameterGroupName>
</ResetDBParameterGroupResult>
  <ResponseMetadata>
  <RequestId>e7620e56-a745-45c1-bca2-fac33f7cb69c</RequestId>
</ResponseMetadata>
</ResetDBParameterGroupResponse>

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