Help Center> Distributed Cache Service> API Reference> API V2> Instance Management> Restarting DCS Instances or Clearing DCS Instance Data
Updated on 2024-04-09 GMT+08:00

Restarting DCS Instances or Clearing DCS Instance Data

Function

This API is used to restart a running DCS instance.

Data clearance operations cannot be undone on DCS Redis 4.0, 5.0, and 6.0 instances.

Calling Method

For details, see Calling APIs.

URI

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.

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 instance process

flush: clear data

NOTE:

Only DCS Redis 4.0, 5.0, and 6.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

Force restarting a DCS instance

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"
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

Force restarting a DCS instance

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dcs.v2.region.DcsRegion;
import com.huaweicloud.sdk.dcs.v2.*;
import com.huaweicloud.sdk.dcs.v2.model.*;

import java.util.List;
import java.util.ArrayList;

public class RestartOrFlushInstancesSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        DcsClient client = DcsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DcsRegion.valueOf("<YOUR REGION>"))
                .build();
        RestartOrFlushInstancesRequest request = new RestartOrFlushInstancesRequest();
        ChangeInstanceStatusBody body = new ChangeInstanceStatusBody();
        List<String> listbodyInstances = new ArrayList<>();
        listbodyInstances.add("2e803f66-fbb0-47ad-b6cb-fb87f5bed4ef");
        body.withAction("restart");
        body.withInstances(listbodyInstances);
        request.withBody(body);
        try {
            RestartOrFlushInstancesResponse response = client.restartOrFlushInstances(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Force restarting a DCS instance

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdcs.v2.region.dcs_region import DcsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdcs.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = DcsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DcsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = RestartOrFlushInstancesRequest()
        listInstancesbody = [
            "2e803f66-fbb0-47ad-b6cb-fb87f5bed4ef"
        ]
        request.body = ChangeInstanceStatusBody(
            action="restart",
            instances=listInstancesbody
        )
        response = client.restart_or_flush_instances(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Force restarting a DCS instance

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dcs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := dcs.NewDcsClient(
        dcs.DcsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.RestartOrFlushInstancesRequest{}
	var listInstancesbody = []string{
        "2e803f66-fbb0-47ad-b6cb-fb87f5bed4ef",
    }
	actionChangeInstanceStatusBody:= "restart"
	request.Body = &model.ChangeInstanceStatusBody{
		Action: &actionChangeInstanceStatusBody,
		Instances: &listInstancesbody,
	}
	response, err := client.RestartOrFlushInstances(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

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.