Updated on 2025-08-05 GMT+08:00

Modifying Instance Specifications

Function

This API is used to modify specifications of a DCS instance in the Running state.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/instances/{instance_id}/resize

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

Project ID. For details, see Obtaining a Project ID.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

instance_id

Yes

String

Definition:

Instance ID. It can be viewed on the instance details page on the DCS console.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

spec_code

Yes

String

Definition:

Flavor after the modification. The query method is as follows:

Constraints:

N/A

Range:

N/A

Default Value:

N/A

new_capacity

Yes

Integer

Definition:

New memory size of the DCS instance, in GB.

Constraints:

For a single-node or master/standby DCS Redis 4.0 or later instance, the value can be 0.125, 0.25, 0.5, 1, 2, 4, 8, 16, 32, or 64. For a cluster DCS Redis 4.0 or later instance, the value can be 4, 8, 16, 24, 32, 48, 64, 96, 128, 192, 256, 384, 512, 768, or 1024. For a read/write splitting DCS Redis 4.0 or later instance, the value can be 1, 2, 4, 8, 16, 32, 64.

For a single-node or master/standby DCS Memcached instance, the value can be 2, 4, 8, 16, 32, or 64.

Currently, the specifications of a Proxy Cluster DCS Redis 3.0 instance cannot be reduced. In addition to integers, 0.125, 0.25, and 0.5 are also supported.

Range:

N/A

Default Value:

N/A

bss_param

No

BssParamEntity object

Definition:

This parameter does not need to be set for pay-per-use instances.

reserved_ip

No

Array of strings

Definition:

IP addresses to retain. Mandatory during cluster scale-in. If this parameter is not set, the system randomly deletes unnecessary shards.

change_type

No

String

Definition:

Modification type. Mandatory when the number of replicas of a DCS Redis instance is modified.

Constraints:

N/A

Range:

  • createReplication: adding replicas

  • deleteReplication: deleting replicas

  • addSharding: adding shards

  • instanceType: changing the instance type. Currently, you can change a master/standby or read/write splitting DCS Redis 4.0/5.0/6.0 instance to the Proxy Cluster type, or from Proxy Cluster to master/standby or read/write splitting[, or from master/standby to read/write splitting].

Default Value:

N/A

available_zones

No

Array of strings

Definition:

Code of the AZ where each replica is in. This parameter is mandatory when you add replicas to a DCS Redis instance. Before specifying an AZ, ensure that there are available resources in it. This parameter is mandatory when you delete replicas from a cluster instance.

For details, see Querying AZs.

node_list

No

Array of strings

Definition:

ID of the replica to delete. This parameter is mandatory when you delete replicas of a master/standby or read/write splitting DCS Redis instance. Currently, only one replica can be deleted at a time.

For details, see Querying Details of Shards and Replicas.

execute_immediately

No

Boolean

Definition:

Whether to apply the change immediately.

Constraints:

N/A

Range:

  • true: Yes

  • false: No. Apply the change in the maintenance time window. Specification changes can be applied during the maintenance window only in some scenarios. For details, see Modifying Specifications.

Default Value:

true.

enable_ipv6

No

Boolean

Parameter description:

Whether IPv6 is enabled.

Constraints:

N/A

Value range:

true: Yes

false: No

Default value:

false

spec_param

No

SpecParam object

Definition:

Linear specification definition parameter.

Constraints:

N/A

Table 3 BssParamEntity

Parameter

Mandatory

Type

Description

is_auto_pay

No

String

Definition:

Indicates whether fees are deducted automatically from the account balance. Non-automatic payment is used by default.

If this parameter is set to true, the automatic payment can only be completed with the account balance. If you want to use cash coupons, set this parameter to false and go to the Billing Center to make the payment.

If this parameter is set to false, go to Billing Center > Orders to pay for the order after modifying specifications or creating an instance. Otherwise, the order is always pending payment and the instance modification or creation is not considered successful.

Constraints:

N/A

Range:

  • true: Fees are automatically deducted from the account balance.

  • false: The order must be paid manually. This is the default value.

Default Value:

false

Table 4 SpecParam

Parameter

Mandatory

Type

Description

sharding_count

No

Integer

Parameter description:

Number of instance shards.

Constraints:

N/A

Value range:

1–128

Default value:

N/A

replica_count

No

Integer

Definition:

Number of instance replicas.

Constraints:

N/A

Range:

1–10

Default Value:

N/A

cache_mode

No

String

Definition:

DCS instance type.

Constraints:

N/A

Range:

  • single: single-node

  • ha: master/standby

  • cluster: Redis Cluster

  • proxy: Proxy Cluster

  • ha_rw_split: read/write splitting

Default Value:

N/A

Response Parameters

Status code: 204

DCS instance specifications modified successfully.

None

Example Requests

  • Changing to a master/standby instance with 3 replicas and 1 GB

    POST https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/resize
    
    {
      "spec_code" : "redis.ha.xu1.large.r3.1",
      "new_capacity" : 1,
      "change_type" : "createReplication",
      "available_zones" : [ "e7afd64502d64fe3bfb60c2c82ec0ec6", "d90ff6d692954373bf53be49cf3900cb" ],
      "execute_immediately" : true
    }
  • Changing to a Redis Cluster instance with 2 replicas and 8 GB

    {
      "spec_code" : "redis.cluster.xu1.large.r2.8",
      "new_capacity" : 8,
      "reserved_ip" : [ "192.168.0.125" ],
      "change_type" : "deleteReplication",
      "execute_immediately" : true
    }

Example Responses

None

SDK Sample Code

The SDK sample code is as follows.

  • Changing to a master/standby instance with 3 replicas and 1 GB

     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
    54
    55
    56
    57
    58
    59
    60
    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 ResizeInstanceSolution {
    
        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");
            String projectId = "{project_id}";
    
            ICredential auth = new BasicCredentials()
                    .withProjectId(projectId)
                    .withAk(ak)
                    .withSk(sk);
    
            DcsClient client = DcsClient.newBuilder()
                    .withCredential(auth)
                    .withRegion(DcsRegion.valueOf("<YOUR REGION>"))
                    .build();
            ResizeInstanceRequest request = new ResizeInstanceRequest();
            request.withInstanceId("{instance_id}");
            ResizeInstanceBody body = new ResizeInstanceBody();
            List<String> listbodyAvailableZones = new ArrayList<>();
            listbodyAvailableZones.add("e7afd64502d64fe3bfb60c2c82ec0ec6");
            listbodyAvailableZones.add("d90ff6d692954373bf53be49cf3900cb");
            body.withExecuteImmediately(true);
            body.withAvailableZones(listbodyAvailableZones);
            body.withChangeType(ResizeInstanceBody.ChangeTypeEnum.fromValue("createReplication"));
            body.withNewCapacity(1);
            body.withSpecCode("redis.ha.xu1.large.r3.1");
            request.withBody(body);
            try {
                ResizeInstanceResponse response = client.resizeInstance(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());
            }
        }
    }
    
  • Changing to a Redis Cluster instance with 2 replicas and 8 GB

     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
    54
    55
    56
    57
    58
    59
    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 ResizeInstanceSolution {
    
        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");
            String projectId = "{project_id}";
    
            ICredential auth = new BasicCredentials()
                    .withProjectId(projectId)
                    .withAk(ak)
                    .withSk(sk);
    
            DcsClient client = DcsClient.newBuilder()
                    .withCredential(auth)
                    .withRegion(DcsRegion.valueOf("<YOUR REGION>"))
                    .build();
            ResizeInstanceRequest request = new ResizeInstanceRequest();
            request.withInstanceId("{instance_id}");
            ResizeInstanceBody body = new ResizeInstanceBody();
            List<String> listbodyReservedIp = new ArrayList<>();
            listbodyReservedIp.add("192.168.0.125");
            body.withExecuteImmediately(true);
            body.withChangeType(ResizeInstanceBody.ChangeTypeEnum.fromValue("deleteReplication"));
            body.withReservedIp(listbodyReservedIp);
            body.withNewCapacity(8);
            body.withSpecCode("redis.cluster.xu1.large.r2.8");
            request.withBody(body);
            try {
                ResizeInstanceResponse response = client.resizeInstance(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());
            }
        }
    }
    
  • Changing to a master/standby instance with 3 replicas and 1 GB

     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
    # coding: utf-8
    
    import os
    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 = os.environ["CLOUD_SDK_AK"]
        sk = os.environ["CLOUD_SDK_SK"]
        projectId = "{project_id}"
    
        credentials = BasicCredentials(ak, sk, projectId)
    
        client = DcsClient.new_builder() \
            .with_credentials(credentials) \
            .with_region(DcsRegion.value_of("<YOUR REGION>")) \
            .build()
    
        try:
            request = ResizeInstanceRequest()
            request.instance_id = "{instance_id}"
            listAvailableZonesbody = [
                "e7afd64502d64fe3bfb60c2c82ec0ec6",
                "d90ff6d692954373bf53be49cf3900cb"
            ]
            request.body = ResizeInstanceBody(
                execute_immediately=True,
                available_zones=listAvailableZonesbody,
                change_type="createReplication",
                new_capacity=1,
                spec_code="redis.ha.xu1.large.r3.1"
            )
            response = client.resize_instance(request)
            print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
    
  • Changing to a Redis Cluster instance with 2 replicas and 8 GB

     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
    # coding: utf-8
    
    import os
    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 = os.environ["CLOUD_SDK_AK"]
        sk = os.environ["CLOUD_SDK_SK"]
        projectId = "{project_id}"
    
        credentials = BasicCredentials(ak, sk, projectId)
    
        client = DcsClient.new_builder() \
            .with_credentials(credentials) \
            .with_region(DcsRegion.value_of("<YOUR REGION>")) \
            .build()
    
        try:
            request = ResizeInstanceRequest()
            request.instance_id = "{instance_id}"
            listReservedIpbody = [
                "192.168.0.125"
            ]
            request.body = ResizeInstanceBody(
                execute_immediately=True,
                change_type="deleteReplication",
                reserved_ip=listReservedIpbody,
                new_capacity=8,
                spec_code="redis.cluster.xu1.large.r2.8"
            )
            response = client.resize_instance(request)
            print(response)
        except exceptions.ClientRequestException as e:
            print(e.status_code)
            print(e.request_id)
            print(e.error_code)
            print(e.error_msg)
    
  • Changing to a master/standby instance with 3 replicas and 1 GB

     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
    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")
        projectId := "{project_id}"
    
        auth := basic.NewCredentialsBuilder().
            WithAk(ak).
            WithSk(sk).
            WithProjectId(projectId).
            Build()
    
        client := dcs.NewDcsClient(
            dcs.DcsClientBuilder().
                WithRegion(region.ValueOf("<YOUR REGION>")).
                WithCredential(auth).
                Build())
    
        request := &model.ResizeInstanceRequest{}
    	request.InstanceId = "{instance_id}"
    	var listAvailableZonesbody = []string{
            "e7afd64502d64fe3bfb60c2c82ec0ec6",
    	    "d90ff6d692954373bf53be49cf3900cb",
        }
    	executeImmediatelyResizeInstanceBody:= true
    	changeTypeResizeInstanceBody:= model.GetResizeInstanceBodyChangeTypeEnum().CREATE_REPLICATION
    	request.Body = &model.ResizeInstanceBody{
    		ExecuteImmediately: &executeImmediatelyResizeInstanceBody,
    		AvailableZones: &listAvailableZonesbody,
    		ChangeType: &changeTypeResizeInstanceBody,
    		NewCapacity: int32(1),
    		SpecCode: "redis.ha.xu1.large.r3.1",
    	}
    	response, err := client.ResizeInstance(request)
    	if err == nil {
            fmt.Printf("%+v\n", response)
        } else {
            fmt.Println(err)
        }
    }
    
  • Changing to a Redis Cluster instance with 2 replicas and 8 GB

     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
    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")
        projectId := "{project_id}"
    
        auth := basic.NewCredentialsBuilder().
            WithAk(ak).
            WithSk(sk).
            WithProjectId(projectId).
            Build()
    
        client := dcs.NewDcsClient(
            dcs.DcsClientBuilder().
                WithRegion(region.ValueOf("<YOUR REGION>")).
                WithCredential(auth).
                Build())
    
        request := &model.ResizeInstanceRequest{}
    	request.InstanceId = "{instance_id}"
    	var listReservedIpbody = []string{
            "192.168.0.125",
        }
    	executeImmediatelyResizeInstanceBody:= true
    	changeTypeResizeInstanceBody:= model.GetResizeInstanceBodyChangeTypeEnum().DELETE_REPLICATION
    	request.Body = &model.ResizeInstanceBody{
    		ExecuteImmediately: &executeImmediatelyResizeInstanceBody,
    		ChangeType: &changeTypeResizeInstanceBody,
    		ReservedIp: &listReservedIpbody,
    		NewCapacity: int32(8),
    		SpecCode: "redis.cluster.xu1.large.r2.8",
    	}
    	response, err := client.ResizeInstance(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

204

DCS instance specifications modified successfully.

Error Codes

See Error Codes.