You need to enable JavaScript to run this app.
Cache for Redis

Cache for Redis

  • Documentation
    • Cache for RedisDevelopment reference (Control plane)API referenceInstance managementRestartDBInstance
Copy page
Download PDF
Instance management
RestartDBInstance
Copy page
Download PDF
RestartDBInstance

Call the RestartDBInstance API to restart a specified Redis instance.

Request type

Asynchronous request.

Precautions

  • Only an instances in the Running status can be restarted.
  • In the process of restarting an instance, access to some services will be affected for a short time. Please proceed with caution.
  • We recommend that you perform restarts during off-peak hours and ensure that applications have an automatic reconnection mechanism.

Request parameters

Name
Type
Required
Example
Description
InstanceId
String
Yes
redis-cn0212gzmh2xs****

Instance ID.

tip

You can call DescribeDBInstances to query the basic information of all Redis instances in a target region, including instance IDs.

ClientToken
String
No
WbiAlPqJM6tMoSOYhT****
To ensure the idempotence of requests and prevent duplicate submission of requests. The client generates the parameter values to ensure the uniqueness among different requests. Values are case-sensitive, no more than 127 ASCII characters.

Response parameters

The current API has no specified response parameters. For more information, see Response structure.

Sample request 

POST https://redis.cn-beijing.volcengineapi.com/?Action=RestartDBInstance&Version=2020-12-07 HTTP/1.1
Host: redis.cn-beijing.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "InstanceId": "redis-cn0212gzmh2xs****"
}

Sample response 

{
    "ResponseMetadata": {
        "RequestId": "202204151543190102120372302566****",
        "Action": "RestartDBInstance",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": null
}

Error codes

For more information, refer to Error codes.

Last updated: 2025.08.14 10:45:20