本文へジャンプします。

ニフティクラウド APIリファレンス

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

RDB:ResetDBParameterGroup

処理概要

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

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

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

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

リクエストパラメーター

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

パラメーター情報

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

パラメーターの適用方法

  • ※MySQL、PostgreSQLの場合、下記のようなルールが存在します
    • "immediate"はdynamicなパラメーターにのみ指定可能
    • "pending-reboot"はdynamic・static両方のパラメーターに指定可能

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

文字列  
ParameterName リセットするパラメーターの名前 文字列  
ResetAllParameters

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

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

レスポンス

XML

status

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

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

エラー

コード メッセージ タイプ HTTP
ステータスコード
説明
DBParameterGroupNotFound DBParameterGroup not found: aaaa Sender 404 DBParameterGroupNameに存在しない名前を指定した場合
InvalidDBParameterGroupState Cannot reset the parameter group because the parameter 'innodb_adaptive_flushing' has pending changes. Sender 400 リセットしたいパラメーターが変更中などの場合
InternalFailure An internal error has occurred. Please try your query again at a later time. Receiver 500 ParameterNameを指定しなかった場合
InvalidParameterValue Invalid ApplyMethod: null. Allowed values are: pending-reboot, immediate Sender 400 ApplyMethodを指定しなかった場合
The following parameters are not defined for the specified group:innodb_adaptive_flushingaaa Sender 400 ParameterNameに存在しないパラメーターを指定した場合
Invalid parameter group name: {0} Sender 400 DBParameterGroupNameに無効な(数字から始まるなど)値を指定した場合
The parameter DBParameterGroupName must be provided and must not be blank. Sender 400 必須のDBParameterGroupNameを指定しなかった場合
InvalidParameterCombination May not specify both ResetAllParameters and a list of parameters to reset. Sender 400 Parameters.member.Nでパラメーターを指定してResetAllParametersもtrueに指定した場合
Must specify either ResetAllParameters or a list of parameters to reset. Sender 400 Parameters.member.NもResetAllParametersも指定しなかった場合
Duplicate parameter found: {0} Sender 400 リセットするパラメーターに同一のものを複数入れた場合
The parameter DBParameterGroupName is not a valid identifier.
Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
Sender 400 DBParameterGroupNameに無効な(数字から始まるなど)値を指定した場合
The parameter 'ft_min_word_len' 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に指定した場合
The parameter '{0}' 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に指定した場合
The parameter '{0}' cannot be reset with an ApplyMethod of pending-reboot because it is a dynamic parameter. Please specify an ApplyMethod of immediate for this parameter. Sender 400 dynamicパラメーターにApplyMethodをpending-rebootに指定した場合
InvalidDBInstanceState 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 以上