All Products
Search
Document Center

Tair:RestartInstance

Last Updated:Jun 18, 2024

Restarts a running ApsaraDB for Redis instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
kvstore:RestartInstanceWRITE
  • DBInstance
    acs:kvstore:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the instance.

r-bp1zxszhcgatnx****
EffectiveTimestringNo

The time when you want to restart the instance. Default value: Immediately. Valid values:

  • Immediately: immediately restarts the instance.
  • MaintainTime: restarts the instance during the maintenance window.
Enumeration Value:
  • 0
  • 1
  • Immediately
  • MaintainTime
Immediately
UpgradeMinorVersionbooleanNo

Specifies whether to update to the latest minor version when the instance is restarted. Valid values:

  • true: updates the minor version.
  • false: does not update the minor version.
Note The default value is true.
true

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

EFC9161F-15E3-4A6E-8A99-C33331****
InstanceIdstring

The ID of the instance.

r-bp1zxszhcgatnx****
TaskIdstring

The ID of the task.

11111****

Examples

Sample success responses

JSONformat

{
  "RequestId": "EFC9161F-15E3-4A6E-8A99-C33331****",
  "InstanceId": "r-bp1zxszhcgatnx****",
  "TaskId": "11111****"
}

Error codes

HTTP status codeError codeError message
403IncorrectEngineVersionCurrent engine version does not support this operation.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-07-20API Description Update. The Error code has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    delete Error Codes: 403