Restarts a running ApsaraDB for Redis instance.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | RestartInstance |
The operation that you want to perform. Set the value to RestartInstance. |
InstanceId | String | Yes | r-bp1zxszhcgatnx**** |
The ID of the instance. |
EffectiveTime | String | No | Immediately |
The time when you want to restart the instance. Valid values:
Note Default value: Immediately.
|
UpgradeMinorVersion | Boolean | No | true |
Specifies whether to upgrade to the latest minor version after the instance is restarted. Valid values:
Note Default value: true.
|
RegionId | String | No | cn-hangzhou |
The ID of the region where the instance is deployed. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
InstanceId | String | r-bp1zxszhcgatnx**** |
The ID of the instance. |
TaskId | String | 11111**** |
The ID of the task. |
RequestId | String | EFC9161F-15E3-4A6E-8A99-C33331**** |
The ID of the request. |
Examples
Sample requests
https://r-kvstore.aliyuncs.com/?Action=RestartInstance
&InstanceId=r-bp1zxszhcgatnx****
&EffectiveTime=Immediately
&<Common request parameters>
Sample success responses
XML
format
<RestartInstanceResponse>
<RequestId>EFC9161F-15E3-4A6E-8A99-6661****</RequestId>
<InstanceId>r-bp1zxszhcgatnx****</InstanceId>
<TaskId>11111****</TaskId>
</RestartInstanceResponse>
JSON
format
{
"RequestId":"EFC9161F-15E3-4A6E-8A99-6661****",
"InstanceId":"r-bp1zxszhcgatnx****",
"TaskId":"11111****"
}
Error codes
For a list of error codes, visit the API Error Center.