CLI Command Reference

Creating a DCS Instance

hcloud DCS CreateInstance

This API is used to create a DCS instance which is billed in pay-per-use mode.

Go debug

Listing All Instances

hcloud DCS ListInstances

This API is used to query DCS instances of a tenant, and allows you to specify query criteria.

Go debug

Batch Deleting Instances

hcloud DCS BatchDeleteInstances

This API is used to delete multiple DCS instances at a time.

Go debug

Querying Details About a Specified Instance

hcloud DCS ShowInstance

This API is used to query the details about a specified DCS instance.

Go debug

Deleting an Instance

hcloud DCS DeleteSingleInstance

This API is used to delete a specified DCS instance to free up all resources occupied by it.

Go debug

Modifying Details of an Instance

hcloud DCS UpdateInstance

This API is used to modify the information about a DCS instance, including the instance name, description, port, backup policy, start and end time of the maintenance window, and security group.

Go debug

Modifying Instance Specifications

hcloud DCS ResizeInstance

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

Go debug

Performing a Master/Standby Switchover

hcloud DCS ChangeMasterStandby

This API is used to perform a master/standby switchover. Only master/standby instances support this operation.

Go debug

Resetting the password

hcloud DCS ResetPassword

Resets the password of a DCS instance.

Go debug

Changing the Password

hcloud DCS UpdatePassword

This API is used to change the password of a DCS instance.

Go debug

Querying the Instance Status

hcloud DCS ListNumberOfInstancesInDifferentStatus

This API is used to query the number of instances in different states.

Go debug

Restarting DCS Instances or Clearing DCS Instance Data

hcloud DCS RestartOrFlushInstances

This API is used to restart running DCS instances.

Go debug

Querying Statistics of All Running Instances

hcloud DCS ListStatisticsOfRunningInstances

This API is used to query the statistics of all DCS instances that are in the **Running** state.

Go debug

Configuring Replica Priority

hcloud DCS UpdateSlavePriority

This API is used to configure the replica priority. When the master node is faulty, a replica with a smaller weight has a higher priority to be promoted to master.

Go debug

Removing the IP Address

hcloud DCS DeleteIpFromDomainName

This API is used to remove the IP address of a read replica from the domain name. After the removal, the read-only domain name will not be resolved to the IP address.

Go debug

Querying Details of Shards and Replicas

hcloud DCS ListGroupReplicationInfo

This API is used to query shards and replicas of cluster instances and read/write splitting instances. Only master/standby DCS Redis 4.0 and 5.0 instances support read/write splitting.

Go debug

Querying DCS Instance Configuration Parameters

hcloud DCS ListConfigurations

This API is used to query the configuration parameters of a DCS instance.

Go debug

Modifying DCS Instance Configuration Parameters

hcloud DCS UpdateConfigurations

You can modify the configuration parameters of your DCS instance to optimize DCS performance based on your requirements.

Go debug

List Config Histories

hcloud DCS ListConfigHistories

Query the parameter modification record list of an instance, and support query by keyword

Go debug

Deleting Backup Files

hcloud DCS DeleteBackupFile

This API is used to delete the backup files of a DCS instance.

Go debug

Restoring a DCS Instance

hcloud DCS RestoreInstance

This API is used to restore the backup data to a specific DCS instance.

Go debug

Listing DCS Instance Restoration Records

hcloud DCS ListRestoreRecords

This API is used to query the restoration records of a specific DCS instance.

Go debug

Obtaining the Backup File URL

hcloud DCS ListBackupFileLinks

This API is used to obtain the download links of backup files.

Go debug

Backing Up a DCS Instance

hcloud DCS CopyInstance

This API is used to back up a specific DCS instance.

Go debug

Listing DCS Instance Backup Records

hcloud DCS ListBackupRecords

This API is used to query the backup records of a specific DCS instance.

Go debug

Creating a Data Migration Task

hcloud DCS CreateMigrationTask

This API is used to create a data migration task.

Go debug

Listing Data Migration Tasks

hcloud DCS ListMigrationTask

This API is used to query the migration task list.

Go debug

Deleting Data Migration Tasks

hcloud DCS DeleteMigrationTask

This API is used to delete data migration tasks.

Go debug

Querying Details of a Data Migration Task

hcloud DCS ShowMigrationTask

This API is used to query migration task details.

Go debug

Stopping a Data Migration Task

hcloud DCS StopMigrationTask

This API is used to stop a data migration task.

Go debug

Querying the Progress of an Online Migration Task

hcloud DCS ShowMigrationTaskStats

This API is used to query progress details about an online migration task.

Go debug

Listing All Tags of a Tenant

hcloud DCS ListTagsOfTenant

This API is used to query the tags of all resources owned by a tenant in a specific project.

Go debug

Batch Adding or Deleting Tags

hcloud DCS BatchCreateOrDeleteTags

This API is used to add or delete tags in batches for a DCS instance.

Go debug

Querying Tags of a DCS Instance

hcloud DCS ShowTags

This API is used to query the tags of an instance by its instance ID.

Go debug

Creating a Big Key Analysis Task

hcloud DCS CreateBigkeyScanTask

This API is used to create a big key analysis task for a DCS Redis instance.

Go debug

Listing Big Key Analysis Tasks

hcloud DCS ListBigkeyScanTasks

This API is used to query the list of big key analysis tasks.

Go debug

Querying Big Key Analysis Details

hcloud DCS ShowBigkeyScanTaskDetails

This API is used to query the big key analysis details.

Go debug

Deleting a Big Key Analysis Task

hcloud DCS DeleteBigkeyScanTask

This API is used to delete a big key analysis task.

Go debug

Configuring Automatic Big Key Analysis

hcloud DCS UpdateBigkeyAutoscanConfig

This API is used to configure automatic big key analysis.

Go debug

Querying the Configurations of Automatic Big Key Analysis

hcloud DCS ShowBigkeyAutoscanConfig

This API is used to query configurations of automatic big key analysis.

Go debug

Creating a Hot Key Analysis Task

hcloud DCS CreateHotkeyScanTask

This API is used to create a hot key analysis task. Redis 3.0 does not support hot key analysis.

Go debug

Listing Hot Key Analysis Tasks

hcloud DCS ListHotKeyScanTasks

This API is used to query the list of hot key analysis tasks.

Go debug

Querying Hot Key Analysis Details

hcloud DCS ShowHotkeyTaskDetails

This API is used to query the hot key analysis details.

Go debug

Deleting a Hot Key Analysis Task

hcloud DCS DeleteHotkeyScanTask

This API is used to delete a hot key analysis task.

Go debug

Configuring Automatic Hot Key Analysis

hcloud DCS UpdateHotkeyAutoScanConfig

This API is used to configure automatic hot key analysis.

Go debug

Querying the Configurations of Automatic Hot Key Analysis

hcloud DCS ShowHotkeyAutoscanConfig

This API is used to query configurations of automatic hot key analysis.

Go debug

Creating an Expired Key Scan Task

hcloud DCS CreateAutoExpireScanTask

This API is used to create an expired key scan task. Redis 3.0 does not support expired key scan.

Go debug

Listing Expired Key Scans

hcloud DCS ListAutoExpireScanTasks

This API is used to query the list of expired key scan tasks.

Go debug

Querying Slow Logs

hcloud DCS ListSlowlog

This API is used to query slow logs.

Go debug

Querying Redis Run Logs

hcloud DCS ListRedislog

This API is used to query the Redis run logs.

Go debug

Collecting Redis Run Logs

hcloud DCS CreateRedislog

This API is used to collect Redis run logs.

Go debug

Obtaining the Log Download Link

hcloud DCS CreateRedislogDownloadLink

This API is used to obtain the link for downloading logs.

Go debug

Creating an ACL Account

hcloud DCS CreateAclAccount

This API is used to create an account with read, write, or read-only permissions for a DCS Redis 4.0 or 5.0 instance (except the Redis Cluster type).

Go debug

Querying the ACL Account List

hcloud DCS ListAclAccounts

This API is used to query the ACL account list.

Go debug

Changing the Password of an ACL Account

hcloud DCS UpdateAclAccountPassWord

This API is used to change the password of an ACL account.

Go debug

Deleting an ACL Account

hcloud DCS DeleteAclAccount

This API is used to delete a normal ACL account.

Go debug

Configuring IP Whitelist Groups

hcloud DCS UpdateIpWhitelist

This API is used to configure IP address whitelist groups for a specific instance, including creating, disabling, editing, and deleting a whitelist.

Go debug

Querying the IP Whitelist of a DCS Instance

hcloud DCS ShowIpWhitelist

This API is used to query the IP address whitelist of a specific instance.

Go debug

Listing Background Tasks

hcloud DCS ListBackgroundTask

This API is used to query the background task list.

Go debug

Deleting a Background Task

hcloud DCS DeleteBackgroundTask

This API is used to delete a background task.

Go debug

Querying Product Flavors

hcloud DCS ListFlavors

This API is used to query the product flavor (parameter **spec_code**) required for configuring a new DCS instance. If no search criterion is specified, all product specifications will be queried by default.

Go debug

Listing Maintenance Time Windows

hcloud DCS ListMaintenanceWindows

The API is used to query the start time and end time of maintenance time windows.

Go debug

Querying Tenant Quotas

hcloud DCS ShowQuotaOfTenant

This API is used to query the default instance quota and total memory quota of a tenant and the maximum and minimum quotas a tenant can apply for. Different tenants have different quotas in different regions.

Go debug

Listing Monitored Objects on Secondary Dimensions Under a Primary Dimension

hcloud DCS ListMonitoredObjectsOfInstance

This API is used to query the monitored objects on secondary dimensions under primary dimension **dcs_instance_id**.

Go debug

Listing Monitored Objects on Primary Dimensions

hcloud DCS ListMonitoredObjects

This API is used to query the monitored objects on primary dimensions **dcs_instance_id** and **dcs_memcached_instance_id**.

Go debug

Querying AZs

hcloud DCS ListAvailableZones

This API is used to query the AZ information of the current region.

Go debug

Creating an Instance Diagnosis Task

hcloud DCS CreateDiagnosisTask

This API is used to diagnose a specific DCS instance.

Go debug

Listing Instance Diagnosis Tasks

hcloud DCS ListDiagnosisTasks

This API is used to query the list of diagnosis tasks of a specific DCS instance.

Go debug

Querying a Specified Diagnosis Report

hcloud DCS ShowDiagnosisTaskDetails

This API is used to query details about a diagnosis report based on the report ID.

Go debug