Creating a DCS Instance

name

String

Yes

DCS instance name.

An instance name can contain 4 to 64 characters and must start with a letter. Only letters, digits, underscores (_), and hyphens (-) are allowed.

description

String

No

Brief description of the DCS instance.

The description supports up to 1024 characters.

engine

String

Yes

Cache engine. Options: Redis or Memcached.

engine_version

String

Yes

Cache engine version. If the cache engine is Redis, the value can be 3.0, 4.0, or 5.0.

spec_code

String

Yes

DCS instance specification code.

To obtain the value, go to the instance creation page on the DCS console, and view Flavor Name in the Instance Specification table.

capacity

Float

Yes

Cache capacity. Unit: GB.

• For a single-node or master/standby DCS Redis 3.0 instance, the value can be 2, 4, 8, 16, 32, or 64. For a Proxy Cluster DCS Redis 3.0 instance, the value can be 64, 128, 256, 512, or 1024.
• For a single-node or master/standby DCS Redis 4.0 or 5.0 instance, the value can be 0.125, 0.25, 0.5, 1, 2, 4, 8, 16, 32, 24, 48, or 64. For a Redis Cluster DCS Redis 4.0 or 5.0 instance, the value can be 4, 8, 16, 24, 32, 48, 64, 96, 128, 192, 256, 384, 512, 768, or 1024.
• For a single-node or master/standby DCS Memcached instance, the value can be 2, 4, 8, 16, 32, or 64.

password

String

No

Password of a DCS instance.

The password of a DCS Redis instance must meet the following complexity requirements:

• Must be a string consisting of 8 to 32 characters.
• Must be different from the old password.
• Contains at least three of the following character types:
  • Lowercase letters
  • Uppercase letters
  • Digits
  • Special characters (`~!@#$^&*()-_=+\|{}:,<.>/?)

access_user

String

No

If the cache engine is Redis, you do not need to set this parameter.

If the cache engine is Memcached, this parameter is available only when no_password_access is set to false, indicating that you need to access the DCS instance in password mode.

A username can contain 1 to 64 characters, including letters, digits, underscores (_), and hyphens (-), and must start with a letter.

vpc_id

String

Yes

VPC ID.

Obtain the value by using either of the following methods:

• Method 1: Log in to VPC console and view the VPC ID in the VPC details.
• Method 2: Call the API for querying VPCs. For details, see the "Querying VPCs" section in the Virtual Private Cloud API Reference.

security_group_id

String

Yes

ID of the security group which the instance belongs to.

This parameter is mandatory when the engine is Redis and engine_version is 3.0, or when engine is Memcached. DCS Redis 3.0 and Memcached instances support security group access control.

This parameter is optional when the engine is Redis and engine_version is 4.0 or 5.0. DCS Redis 4.0 and 5.0 instances do not support security groups.

Obtain the value by using either of the following methods:

• Method 1: Log in to the VPC console and view the security group ID on the security group details page.
• Method 2: Call the API for querying security groups. For details, see the "Querying Security Groups" section in the Virtual Private Cloud API Reference.

subnet_id

String

Yes

Network ID of the subnet.

Obtain the value by using either of the following methods:

• Method 1: Log in to VPC console and click the target subnet on the Subnets tab page. You can view the network ID on the displayed page.
• Method 2: Call the API for querying subnets. For details, see the "Querying Subnets" section in the Virtual Private Cloud API Reference.

available_zones

Array

Yes

ID of the AZ where the cache node resides and which has available resources. For details on how to obtain the value, see Querying AZ Information. Check whether the AZ has available resources.

Master/Standby, Proxy Cluster, and Redis Cluster DCS instances support cross-AZ deployment. You can specify an AZ for the standby node. When specifying AZs for nodes, use commas (,) to separate multiple AZs. For details, see the example request.

instance_backup_policy

Object

No

Backup policy.

This parameter is available for master/standby and cluster DCS instances. For details, see Table 4 and Table 5.

maintain_begin

String

No

Time at which the maintenance time window starts.

Format: hh:mm:ss.

• The start time and end time of the maintenance time window must indicate the time segment of a supported maintenance time window. For details on how to query the time segments of supported maintenance time windows, see Querying Maintenance Time Window.
• The start time must be set to 22:00:00, 02:00:00, 06:00:00, 10:00:00, 14:00:00, or 18:00: 00.
• Parameters maintain_begin and maintain_end must be set in pairs. If parameter maintain_start is left blank, parameter maintain_end is also blank. In this case, the system automatically set the start time to 02:00:00.

maintain_end

String

No

Time at which the maintenance time window ends.

Format: hh:mm:ss.

• The start time and end time of the maintenance time window must indicate the time segment of a supported maintenance time window. For details on how to query the time segments of supported maintenance time windows, see Querying Maintenance Time Window.

• The end time is four hours later than the start time. For example, if the start time is 22:00:00, the end time is 02:00:00.
• Parameters maintain_begin and maintain_end must be set in pairs. If parameter maintain_end is left blank, parameter maintain_start is also blank. In this case, the system automatically set the end time to 06:00:00.

tags

Array of Objects

No

Instance tag key and value. For details, see Table 3.

port

Integer

No

Port customization, which is supported only by Redis 4.0 and Redis 5.0 instances and not by Redis 3.0 and Memcached instances.

If this parameter is not sent or is left empty when you create a Redis 4.0 or 5.0 instance, the default port 6379 will be used. To customize a port, specify a port number in the range from 1 to 65535.

rename_commands

Object

No

Critical command renaming, which is supported only by Redis 4.0 and Redis 5.0 instances and not by Redis 3.0 and Memcached instances.

If this parameter is not sent or is left empty when you create a Redis 4.0 or 5.0 instance, no critical command will be renamed. Currently, only COMMAND, KEYS, FLUSHDB, FLUSHALL, and HGETALL commands can be renamed.

key

No

String

Tag key, which

• Cannot be left blank.
• Must be unique.
• Can contain a maximum of 36 characters.

value

No

String

Tag value, which

• Is mandatory when action is set to create and optional when action is set to delete.
• Can contain a maximum of 43 characters.

save_days

Integer

No

This parameter is mandatory when backup_type is set to manual.

Retention period.

Unit: day.

Value range: 1–7.

backup_type

String

No

Backup type.

Options:

• auto: automatic backup.
• manual: manual backup.

The default value is manual.

periodical_backup_plan

Object

Yes

Backup plan. For details, see Table 5.

begin_at

String

Yes

Time at which backup starts.

"00:00-01:00" indicates that backup starts at 00:00:00.

period_type

String

Yes

Interval at which backup is performed.

Currently, only weekly backup is supported.

backup_at

Array

Yes

Day in a week on which backup starts.

Value range: 1–7, where 1 indicates Monday and 7 indicates Sunday.

timezone_offset

String

No

Time zone in which backup is performed.

Value range: GMT–12:00 to GMT+12:00. If this parameter is left blank, the current time zone of the DCS-Server VM is used by default.

instance_id

String

DCS instance ID.

instance_name

String

DCS instance name.

200

DCS instance created successfully.