This API is used to restart a running DCS instance.
Data clearance operations cannot be undone on DCS Redis 4.0 and 5.0 instances.
PUT /v1.0/{project_id}/instances/status
Parameter |
Type |
Mandatory |
Description |
---|---|---|---|
project_id |
String |
Yes |
Project ID. For details on how to obtain the value of this parameter, see Obtaining a Project ID. |
Request parameters
Example request
PUT https://{dcs_endpoint}/v1.0/{project_id}/instances/status
{ "action": "restart", "instances": [ "2e803f66-fbb0-47ad-b6cb-fb87f5bed4ef" ] }
Response parameters
Parameter |
Type |
Description |
---|---|---|
instance |
String |
DCS instance ID. |
result |
String |
Instance modification result. Options: success or failed |
{ "results": [ { "result": "success", "instance": "2e803f66-fbb0-47ad-b6cb-fb87f5bed4ef" } ] }