Restarts an instance.
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 Resourcesis 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:RestartDBInstance | WRITE |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|
The current API does not require request parameters
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "65BDA532-28AF-4122-AA39-B382721EEE64"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | GeneralIns.Creating | The general instance is creating. | An RDS instance is in production. Please wait. |
| 400 | GeneralIns.Maintaining | The general instance is maintaining. | An RDS instance is being migrated or maintained. Please wait. |
| 400 | GeneralIns.Switching | The general instance is Switching. | A switchover for high availability is in progress. Please wait. |
| 400 | InvalidDBInstanceStatus.NotSupport | The Specified instance status is not supported to restart instance. | - |
| 400 | InvalidEffectiveTime.SpecialTimeIsNull | SpecialTime is not valid. | - |
| 400 | IncorrectDBInstanceLockMode.ValueNotSupported | The Current DB instance lock mode does not support this operation. | The operation failed. The RDS instance is locked. |
| 400 | InvalidDBInstanceName.Format | Specified DB instance name is not valid. | The instance does not exist. Check the instance information. |
| 403 | IncorrectRestartMethod | The specified RestartMethod params is not valid. | - |
| 403 | IncorrectEffectiveTime | The specified EffectiveTime params is not valid. | The value of the EffectiveTime parameter is invalid. |
| 403 | IncorrectDBInstanceType | Current DB instance type does not support this operation. | The operation failed. The RDS instance is not in a ready state. |
| 403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | - |
| 403 | InvalidKmsKey | Kms key is disabled. | - |
| 403 | IncorrectDBInstanceCharacterType | Current DB Instance character_type does not support this operation. | This operation is not supported for the character type of the current instance. |
| 403 | InvalidRestartPolicy.Format | Specified Restart Policy is not valid. | - |
| 404 | InvalidDBInstanceName.NotFound | The database instance does not exist. | The name of the RDS instance cannot be found. Check the name of 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. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 2022-10-28 | The error codes of the API operation change. | |||||||||
| ||||||||||
| 2022-07-08 | The error codes of the API operation change. | |||||||||
|