Chen, Junjie a03981f7be DCS API 20230220 Version

Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com>
Co-authored-by: Chen, Junjie <chenjunjie@huawei.com>
Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>

2024-04-22 14:08:39 +00:00

12 KiB

Raw Permalink Blame History

Modifying Instance Specifications

Function

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

URI

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

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

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
spec_code	Yes	String	Flavor after the modification. The query method is as follows: Method 1: Log in to the DCS console, go to the instance creation page, and check the instance flavor. Method 2: Call the API used to query product flavors.
new_capacity	Yes	Integer	New memory size of the DCS instance, in GB. For a single-node or master/standby DCS Redis 4.0, 5.0, or 6.0 instance, the value can be 0.125, 0.25, 0.5, 1, 2, 4, 8, 16, 32, or 64. For a cluster instance, the value can be 4, 8, 16, 24, 32, 48, 64, 96, 128, 192, 256, 384, 512, 768, or **1024. 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.
bss_param	No	BssParamEntity object	This parameter does not need to be set for pay-per-use instances.
reserved_ip	No	Array of strings	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	Modification type. Mandatory when the number of replicas of a DCS Redis 4.0 or 5.0 instance is modified. createReplication: adding replicas deleteReplication: deleting replicas addSharding: adding shards instanceType: changing the instance type.. Enumeration values: createReplication deleteReplication addSharding instanceType
available_zones	No	Array of strings	Code of the AZ where each replica is in. This parameter is mandatory when you add replicas to a DCS Redis 4.0 or 5.0 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	ID of the replica to delete. This parameter is mandatory when you delete replicas of a master/standby DCS Redis 4.0 or 5.0 instance. Currently, only one replica can be deleted at a time. For details, see Querying Details of Shards and Replicas.
execute_immediately	No	Boolean	Whether to apply the change immediately. Options: true (default): Apply the change immediately. false: Apply the change during the maintenance window. .

**Table 3** BssParamEntity
Parameter	Mandatory	Type	Description
is_auto_pay	No	String	This parameter is reserved.

Response Parameters

None

Example Requests

Changing instance specifications to 1 GB.

POST https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/resize

{
  "spec_code" : "redis.ha.xu1.tiny.r2.1",
  "new_capacity" : 1,
  "reserved_ip" : [ "192.168.0.125" ],
  "change_type" : "createReplication",
  "available_zones" : [ "e7afd64502d64fe3bfb60c2c82ec0ec6", "d90ff6d692954373bf53be49cf3900cb" ],
  "node_list" : [ "ff80808282eee5f90183120188ae093e" ],
  "execute_immediately" : true
}

Example Responses

None

Status Codes

Status Code	Description
204	DCS instance specifications modified successfully.

Error Codes

See Error Codes.

Parent topic: Lifecycle Management

12 KiB Raw Permalink Blame History