Restarting DCS Instances or Clearing DCS Instance Data

This API is used to restart a running DCS instance.

Data clearance operations cannot be undone on DCS Redis 4.0 and later instances.

For details, see Calling APIs.

PUT /v2/{project_id}/instances/status

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID.

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
instances	No	Array of strings	List of instance IDs.
action	No	String	Operation on the instance: restart: force restart soft_restart: restart only the instance process flush: clear data NOTE: Only DCS Redis 4.0 and later instances can be flushed.

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
results	Array of BatchOpsResult objects	Result of deleting, restarting, or clearing data of an instance.

**Table 4** BatchOpsResult
Parameter	Type	Description
result	String	Instance deletion result. Options: success and failed.
instance	String	DCS instance ID.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_msg	String	Parameter description: Error message. Value range: N/A.
error_code	String	Parameter description: Error code. Value range: For details, see Error Codes.
error_ext_msg	String	Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A.

Status code: 500

**Table 6** Response body parameters
Parameter	Type	Description
error_msg	String	Parameter description: Error message. Value range: N/A.
error_code	String	Parameter description: Error code. Value range: For details, see Error Codes.
error_ext_msg	String	Parameter description: Extended error information. This parameter is not used currently and is set to null. Value range: N/A.

Force restarting a DCS instance

PUT https://{dcs_endpoint}/v2/{project_id}/instances/status

{
  "instances" : [ "2e803f66-fbb0-47ad-b6cb-fb87f5bed4ef" ],
  "action" : "restart"
}

Status code: 200

DCS instances restarted successfully or the instance data cleared successfully.

{
  "results" : [ {
    "instance" : "e3a7019c-8824-4c1a-8289-5300f19b9f64",
    "result" : "success"
  } ]
}

Status Code	Description
200	DCS instances restarted successfully or the instance data cleared successfully.
400	Invalid request.
500	Internal service error.

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.