Help Center/ Distributed Cache Service/ API Reference/ API V2/ Instance Management/ Restarting DCS Instances or Clearing DCS Instance Data
Updated on 2022-09-19 GMT+08:00
View PDF

Restarting DCS Instances or Clearing DCS Instance Data

Function

This API is used to restart running DCS instances.

This API can also be used to clear data of DCS Redis 4.0 and 5.0 instances. Cleared data cannot be recovered. Exercise caution when performing this operation.

URI

PUT /v2/{project_id}/instances/status

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Request Parameters

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 process

flush: clear data

NOTE:

Only DCS Redis 4.0 and 5.0 instances can be flushed.

Response Parameters

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

Error message.

Maximum: 1024

error_code

String

Error code.

Maximum: 9

error_ext_msg

String

Extended error information. This parameter is not used currently and is set to null.

Maximum: 1024

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

Maximum: 1024

error_code

String

Error code.

Maximum: 9

error_ext_msg

String

Extended error information. This parameter is not used currently and is set to null.

Maximum: 1024

Example Requests

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

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

Example Responses

Status code: 200

DCS instances restarted successfully or the instance data cleared successfully.

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

Status Codes

Status Code

Description

200

DCS instances restarted successfully or the instance data cleared successfully.

400

Invalid request.

500

Internal service error.

Error Codes

See Error Codes.

Parent topic: Instance Management