Modifies the parameter values of an instance.
Operation description
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
rds:ModifyParameter | WRITE |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
ClientToken | string | No | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. | ETnLKlblzczshOTUbOCzxxxxxxxxxx |
DBInstanceId | string | Yes | The instance ID. | rm-uf6wjk5xxxxxxx |
Parameters | string | No | The JSON strings of parameters and their values. All the parameter values are of the string type. Format: {"Parameter name 1":"Parameter value 1","Parameter name 2":"Parameter value 2"...}. You can call the DescribeParameterTemplates operation to query parameter names and values. Note
If you specify this parameter, you do not need to specify ParameterGroupId.
| {"delayed_insert_timeout":"600","max_length_for_sort_data":"2048"} |
Forcerestart | boolean | No | Specifies whether to restart the instance for a new parameter value to take effect. Valid values:
Default value: false. | false |
ParameterGroupId | string | No | The parameter template ID. Note
| rpg-xxxxxxxxx |
SwitchTimeMode | string | No | The time at which the modification takes effect. Valid values:
| ScheduleTime |
SwitchTime | string | No | The time at which the modification takes effect. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note
This time must be later than the time at which you call this operation.
| 2022-05-06T09:24:00Z |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "542BB8D6-4268-45CC-A557-B03EFD7AB30A"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | PendingActionOverdue | the action execution time is already overdue | The specified execution time has expired. |
400 | EngineMigration.ActionDisabled | Specified action is disabled while custins is in engine migration. | The specified operation is disabled when the instance is being migrated across engines. |
400 | %s | The following parameters are prohibited: <br />%s | - |
400 | Invalid.ParamGroupDBCategory | ParamGroup category is basic, not standard. | The parameter group is a basic parameter group not a standard parameter group. |
400 | InvalidEffectiveTime.SpecialTimeIsNull | SpecialTime is not valid. | - |
400 | InvalidParameters.Format | Specified parameters is not valid. | The values of some parameters are invalid. |
400 | StorageEngine.NotSupported | Current instance storage engine dose not support this operation. | - |
400 | InvalideStatus.Format | The instance status does not support this operation. | - |
403 | IncorrectDBInstanceType | The current database instance type does not support the operation. | This operation is not supported for the database engine of the current instance. |
403 | IncorrectDBInstanceState | The current database status does not support the operation. | The operation failed. The RDS instance is not running. |
403 | ParamNotSupportedForCurrentVersion | Parameter is not supported for current version. | - |
403 | Invalid.Parameter | Specified parameters is not valid. | The specified parameter is invalid. |
403 | IncorrectEffectiveTime | The specified EffectiveTime params is not valid. | The value of the EffectiveTime parameter is invalid. |
403 | GroupReplicationNotSupport.InvalidEngineVersion | Group Replication requires the instance engine version to be 8.0. | - |
403 | GroupReplicationNotSupport.InvalidNodeClassCode | Group Replication requires the ClassCode of each node to be consistent. | - |
403 | GroupReplicationNotSupport.InvalidNodeNum | Group Replication is not supported, the number of nodes must be an odd number greater than or equal to 3. | - |
403 | GroupReplicationNotSupport.InvalidXengine | Group Replication is not supported because the instance has xengine tables. | - |
403 | GroupReplicationNotSupport.MemoryTooSmall | Group Replication is not supported because the memory is too small. | - |
403 | IncorrectMinorVersion | Current engine minor version does not support operations. | This operation is not supported for the current minor engine version. |
403 | GroupReplicationNotSupport.TableWithoutPrimaryKey | Group Replication is not supported because the instance exists table has no primary key. | The instance has tables without primary keys and does not support MySQL group replication (MGR). |
403 | IncorrectDBInstance | The current DB instance does not support this operation. | The operation failed. The operation is not supported for the RDS instance. |
404 | InvalidDBInstance.NotFound | The specified instance does not exist or is not supported. | The RDS instance cannot be found. Check the ID or name of the RDS instance. |
404 | InvalidParam | Sepcified wal_level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica. | - |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-12-21 | The Error code has changed | see changesets | ||||||||||||||
| ||||||||||||||||
2023-06-28 | The Error code has changed | see changesets | ||||||||||||||
| ||||||||||||||||
2023-06-20 | The Error code has changed | see changesets | ||||||||||||||
| ||||||||||||||||
2023-05-09 | The Error code has changed | see changesets | ||||||||||||||
| ||||||||||||||||
2023-04-25 | The Error code has changed | see changesets | ||||||||||||||
| ||||||||||||||||
2022-10-28 | The Error code has changed | see changesets | ||||||||||||||
| ||||||||||||||||
2021-10-26 | The Error code has changed | see changesets | ||||||||||||||
| ||||||||||||||||
2021-10-26 | The Error code has changed. The request parameters of the API has changed | see changesets | ||||||||||||||
| ||||||||||||||||
2021-10-26 | The Error code has changed | see changesets | ||||||||||||||
|