Distributed Cache Service (DCS)¶

The DCS client is the command-line interface (CLI) for the Distributed Cache Service (DMS) API and its extensions.

For help on a specific dcs command, enter:

$ openstack dcs help SUBCOMMAND

Instance operations¶

dcs instance backup create¶

Create a backup of a DCS instance

openstack dcs instance backup create
    [--description <description>]
    <instance>

--description <description>¶: Description of the backup.

instance¶: Name or ID of the DCS instance to take backup from.

This command is provided by the otcextensions plugin.

dcs instance backup delete¶

Delete DCS instance backup

openstack dcs instance backup delete <instance> <backup> [<backup> ...]

instance¶: ID of the instance.

backup¶: ID of the instance backup to delete.

This command is provided by the otcextensions plugin.

dcs instance backup list¶

List backups of a single DCS instance

openstack dcs instance backup list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--limit <limit>]
    [--start <start>]
    [--from_time <yyyyMMddHHmmss>]
    [--to_time <yyyyMMddHHmmss>]
    <instance>

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--limit <limit>¶: Limit number of records to return.

--start <start>¶: Start number for querying.

--from_time <yyyyMMddHHmmss>¶: Start time of the period to be queried.

--to_time <yyyyMMddHHmmss>¶: End time of the period to be queried.

instance¶: Name or ID of the instance

This command is provided by the otcextensions plugin.

dcs instance backup restore¶

Restore a backup of a DCS instance

openstack dcs instance backup restore
    --backup <id>
    [--description <description>]
    <instance>

--backup <id>¶: ID of the backup to restore.

--description <description>¶: Description for the restore record.

instance¶: Name or ID of the DCS instance to take backup from.

This command is provided by the otcextensions plugin.

dcs instance changepwd¶

Change a password of a single DCS instance

openstack dcs instance changepwd
    [--current_password <pwd>]
    [--new_password <pwd>]
    <instance>

--current_password <pwd>¶: Current instance password

--new_password <pwd>¶: New password of a DCS instance. Password complexity requirements: * A string of 8-32 characters. * Contains at least three types of the following characters: * Uppercase letters * Lowercase letters * Digits * Special characters, such as ~!@#$%%^&*()-_=+|[{}]:’”,<.>/?

instance¶: ID or Name of the instance to modify

This command is provided by the otcextensions plugin.

dcs instance create¶

Create a single DCS instance

openstack dcs instance create
    --name <name>
    [--description <description>]
    [--engine <engine>]
    [--engine_version <version>]
    --capacity <size>
    --password <password>
    --vpc_id <id>
    --security_group_id <id>
    --subnet_id <id>
    --az <az>
    --product_id
    {OTC_DCS_SINGLE,OTC_DCS_CL,OTC_DCS_MS}
    [--backup_policy <json>]
    [--maintain_begin <HH:mm:ss>]
    [--maintain_end <HH:mm:ss>]

--name <name>¶: DCS instance name. An instance name is a string of 4-64 characters that contain letters, digits, underscores (_), and hyphens (-). An instance name must start with letters.

--description <description>¶: Brief description of the DCS instance. A brief description supports up to 1024 characters. NOTE “” is defined as an escape character in the queue description. If you need to enter a backward slash () or a double quotation mark (”) in the queue description, enter or “

--engine <engine>¶: Cache engine, which is Redis.

--engine_version <version>¶: Cache engine version, which is 3.0.7.

--capacity <size>¶: Cache capacity. Unit: GB. For a single-node DCS instance and master/standby DCS instance, the cache capacity can be: 1, 2, 4, 8, 16, 32, or 64 GB. For a DCS instance in cluster mode, the cache capacity can be 64, 128, 256, or 512 GB.

--password <password>¶: Password of a DCS instance. Password complexity requirements: * A string of 8-32 characters. * Contains at least three types of the following characters: * Uppercase letters * Lowercase letters * Digits * Special characters, such as ~!@#$%%^&*()-_=+|[{}]:’”,<.>/?

--vpc_id <id>¶: Tenant’s Virtual Private Cloud (VPC) ID.

--security_group_id <id>¶: Tenant’s security group ID.

--subnet_id <id>¶: Subnet ID.

--az <az>¶: Availability zone.

--product_id {OTC_DCS_SINGLE,OTC_DCS_CL,OTC_DCS_MS}¶: Product ID used to differentiate DCS instance types. Values: * OTC_DCS_SINGLE: indicates a single-node DCS instance. * OTC_DCS_MS: indicates a master/standby DCS instance. * OTC_DCS_CL: indicates a DCS instance in cluster mode.

--backup_policy <json>¶: Backup policy JSON. { “save_days” - retention time [1-7] “backup_type” - [auto,manual] “periodical_backup_plan”: { “begin_at” - time when backup starts “period_type” - [weekly] “backup_at” - array of days [1-7] } }

--maintain_begin <HH:mm:ss>¶: Time at which the maintenance time window starts. 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 allocates the default start time 02:00:00.

--maintain_end <HH:mm:ss>¶: Time at which the maintenance time window starts. 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 allocates the default end time 06:00:00.

This command is provided by the otcextensions plugin.

dcs instance delete¶

Delete DCS Instance

openstack dcs instance delete <instance> [<instance> ...]

instance¶: Name or ID of the instance to delete.

This command is provided by the otcextensions plugin.

dcs instance extend¶

Extend capacity of a single DCS instance

openstack dcs instance extend --capacity <size> <instance>

--capacity <size>¶: Value in GB for the new instance capacity.

instance¶: ID or Name of the instance to modify

This command is provided by the otcextensions plugin.

dcs instance list¶

List DCS Instances

openstack dcs instance list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--limit <limit>]
    [--start <start>]
    [--name <name>]
    [--status {CREATING,CREATEFAILED,RUNNING,ERROR,STARTING,RESTARTING,CLOSING,CLOSED,EXTENDING}]
    [--include_failure]
    [--exact_match]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--limit <limit>¶: Limit number of records to return.

--start <start>¶: Start number for querying.

--name <name>¶: DCS instance name.

--status {CREATING,CREATEFAILED,RUNNING,ERROR,STARTING,RESTARTING,CLOSING,CLOSED,EXTENDING}¶: DCS instance status value to query.

--include_failure¶: An indicator of whether the number of DCS instances that failed to be created will be returned to the API caller.

--exact_match¶: An indicator of whether to perform an exact or fuzzy match based on instance name.

This command is provided by the otcextensions plugin.

dcs instance params list¶

List configurational parameters of a single DCS instance

openstack dcs instance params list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    <instance>

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

instance¶: Name or ID of the instance

This command is provided by the otcextensions plugin.

dcs instance params show¶

Show the details of a single instance parameter

openstack dcs instance params show --param <param> <instance>

--param <param>¶: ID or name of the parameter.

instance¶: Name or UUID of the instance.

This command is provided by the otcextensions plugin.

dcs instance params update¶

Update instance configurational parameters

openstack dcs instance params update
    --param <id
    :name:value>
    <instance>

--param <id:name:value>¶: Parameter pair in format ID:NAME:VALUE.

instance¶: Name or ID of the DCS instance to take backup from.

This command is provided by the otcextensions plugin.

dcs instance restart¶

Restart a single DCS instance

openstack dcs instance restart <instance>

instance¶: ID or Name of the instance to modify

This command is provided by the otcextensions plugin.

dcs instance restore list¶

List restore records of a single DCS instance

openstack dcs instance restore list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    [--limit <limit>]
    [--start <start>]
    [--from_time <yyyyMMddHHmmss>]
    [--to_time <yyyyMMddHHmmss>]
    <instance>

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--limit <limit>¶: Limit number of records to return.

--start <start>¶: Start number for querying.

--from_time <yyyyMMddHHmmss>¶: Start time of the period to be queried.

--to_time <yyyyMMddHHmmss>¶: End time of the period to be queried.

instance¶: Name or ID of the instance

This command is provided by the otcextensions plugin.

dcs instance set¶

Update a single DCS instance

openstack dcs instance set
    [--name <name>]
    [--description <description>]
    [--security_group_id <id>]
    [--backup_policy <json>]
    [--maintain_begin <HH:mm:ss>]
    [--maintain_end <HH:mm:ss>]
    <instance>

--name <name>¶: DCS instance name. An instance name is a string of 4-64 characters that contain letters, digits, underscores (_), and hyphens (-). An instance name must start with letters.

--description <description>¶: Brief description of the DCS instance. A brief description supports up to 1024 characters. NOTE “” is defined as an escape character in the queue description. If you need to enter a backward slash () or a double quotation mark (”) in the queue description, enter or “

--security_group_id <id>¶: Tenant’s security group ID.

--backup_policy <json>¶: Backup policy JSON. { “save_days” - retention time [1-7] “backup_type” - [auto,manual] “periodical_backup_plan”: { “begin_at” - time when backup starts “period_type” - [weekly] “backup_at” - array of days [1-7] } }

--maintain_begin <HH:mm:ss>¶: Time at which the maintenance time window starts. 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 allocates the default start time 02:00:00.

--maintain_end <HH:mm:ss>¶: Time at which the maintenance time window starts. 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 allocates the default end time 06:00:00.

instance¶: ID or Name of the instance to modify

This command is provided by the otcextensions plugin.

dcs instance show¶

Show the details of a single instance

openstack dcs instance show <instance>

instance¶: Name or UUID of the instance.

This command is provided by the otcextensions plugin.

dcs instance start¶

Start a single DCS instance

openstack dcs instance start <instance>

instance¶: ID or Name of the instance to modify

This command is provided by the otcextensions plugin.

dcs instance stop¶

Stop a single DCS instance

openstack dcs instance stop <instance>

instance¶: ID or Name of the instance to modify

This command is provided by the otcextensions plugin.

Statistics operations¶

dcs stat list¶

List DCS Statistics

openstack dcs stat list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

This command is provided by the otcextensions plugin.

last updated: 2023-06-12 09:35