ResetDBParameterGroup
処理概要
DBパラメーターグループのパラメーターをデフォルト値にリセットします。
特定のパラメーターをリセットするにはParameterName(パラメーター名)とApplyMethod(適用方法)を指定します。
すべてのパラメーターをリセットするには、DBParameterGroupName(DBパラメーターグループ名)とResetAllParameters(すべてのパラメータをリセットするフラグ)を指定します。
すべてのパラメーターをリセットする場合、dynamicパラメーターはただちに適用されますが、staticパラメーターはステータスがpending-reboot(再起動待ち)に変わり、DBサーバーが再起動されるかRebootInstanceアクションが呼び出されたときに適用が行われます。
指定するパラメーター
| パラメーター | 型 | 説明 | 必須 |
|---|---|---|---|
| DBParameterGroupName | string |
DBパラメーターグループ名 |
○ |
| Parameters.member.N.ApplyMethod | string |
パラメーターの適用方法
値:
|
○ (ResetAllParametersを指定しない場合) |
| Parameters.member.N.ParameterName | string |
リセットするパラメーターの名前
|
○ (ResetAllParametersを指定しない場合) |
| ResetAllParameters | boolean |
すべてのパラメーター値をデフォルト値に戻すかどうか
|
○ (Parameters.member.Nを指定しない場合) |
応答フィールド
| フィールド (項目) | 型 | 説明 |
|---|---|---|
| ResetDBParameterGroupResponse | structure |
ルート |
| ␣ResetDBParameterGroupResult | structure |
結果 |
| ␣␣DBParameterGroupName | string |
DBパラメーターグループ名 |
| ␣ResponseMetadata | structure |
共通メタ情報 |
| ␣␣RequestId | string |
リクエスト識別子 |
エラー
| コード | メッセージ | タイプ | 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 | 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: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」の場合 |
| Client.ResourceIncorrectState.DBInstanceUsingDBParameterGroupDBInstanceUpgradeStatus.Processing | Cannot modify the DBParameterGroup because DB Instance upgrade status using the DBParameterGroup is processing. |
Sender | 400 | DBパラメーターグループを使用しているDBサーバーの基盤アップグレードステータスが処理中（「required」、「latest」以外）の場合 |
リクエストサンプル
https://jp-east-1.rdb.api.nifcloud.com/
?Action=ResetDBParameterGroup
&DBParameterGroupName=mydbparametergroup
&ResetAllParameters=true
&SignatureVersion=2
&SignatureMethod=HmacSHA256
&Timestamp=2013-12-09T00:00:00.000Z
&AWSAccessKeyId=<NIFCLOUD Access Key ID>
&Signature=<Signature>
応答サンプル
<ResetDBParameterGroupResponse>
<ResetDBParameterGroupResult>
<DBParameterGroupName>mydbparametergroup</DBParameterGroupName>
</ResetDBParameterGroupResult>
<ResponseMetadata>
<RequestId>e7620e56-a745-45c1-bca2-fac33f7cb69c</RequestId>
</ResponseMetadata>
</ResetDBParameterGroupResponse>
