Updated on 2026-11-16 GMT+08:00

CLI Command Reference

API Version Queries

API

Command

Description

Operation

Querying Supported API Versions

hcloud DDS ListApiVersion

This API is used to query the supported API versions.

Debug

Querying a Specified API Version

hcloud DDS ShowApiVersion

This API is used to query version information of a specified API.

Debug

DB Engine Versions and Specifications

API

Command

Description

Operation

Querying Database Version Information

hcloud DDS ListDatastoreVersions

This API is used to query database version information of a specified type of instances.

Debug

Querying All Instance Specifications

hcloud DDS ListFlavors

This API is used to query all instance specifications under a specified condition.

Debug

Querying Database Specifications

hcloud DDS ListFlavorInfos

This API is used to query instance specifications under a specified condition.

Debug

Querying Database Storage Types

hcloud DDS ListStorageType

This API is used to query the database storage type in the current region.

Debug

Instance Management

API

Command

Description

Operation

Creating an Instance

hcloud DDS CreateInstance

This API is used to create cluster, replica set, and single node instances.

Debug

Querying Instances and Details

hcloud DDS ListInstances

This API is used to query instances and details based on specified conditions.

Debug

Restarting an Instance

hcloud DDS RestartInstance

This API is used to restart an instance.

Debug

Deleting an Instance

hcloud DDS DeleteInstance

This API is used to delete an instance.

Debug

Changing an Instance Description

hcloud DDS UpdateInstanceRemark

This API is used to modify the description of an instance.

Debug

Scaling Up Storage Space

hcloud DDS ResizeInstanceVolume

This API is used to scale up the storage space of an instance.

Debug

Adding Nodes for a Cluster Instance

hcloud DDS AddShardingNode

This API is used to add nodes for a specified cluster instance.

Debug

Changing Instance Specifications

hcloud DDS ResizeInstance

This API is used to change specifications of an instance.

Debug

Performing a Primary/Secondary Switchover

hcloud DDS SwitchoverReplicaSet

This API is used to perform a primary/secondary switchover for an instance.

Debug

Enabling or Disabling SSL

hcloud DDS SwitchSsl

This API is used to enable or disable SSL for an instance.

Debug

Changing an Instance Name

hcloud DDS UpdateInstanceName

This API is used to change the name of an instance.

Debug

Changing a Database Port

hcloud DDS UpdateInstancePort

This API is used to change the database port of an instance.

Debug

Changing the Security Group of an Instance

hcloud DDS UpdateSecurityGroup

This API is used to change the security group associated with an instance.

Debug

Binding an EIP

hcloud DDS AttachEip

This API is used to bind an EIP to a node in an instance.

Debug

Unbinding an EIP

hcloud DDS CancelEip

This API is used to unbind an EIP from a node in an instance.

Debug

Binding a Public Gateway

hcloud DDS BindPublicGateway

This API is used to bind a public gateway to a node in an instance.

Debug

Unbinding a Public Gateway

hcloud DDS UnbindPublicGateway

This API is used to unbind a public gateway from a node in an instance.

Debug

Changing the Private IP Address of an Instance

hcloud DDS AttachInternalIp

This API is used to change the private IP address of an instance.

Debug

Creating a Shard or Config IP Address for a Cluster Instance

hcloud DDS CreateIp

This API is used to create a shard or config IP address for a cluster instance.

Debug

Configuring Cross-CIDR Access for a Replica Set Instance

hcloud DDS UpdateClientNetwork

This API is used to configure cross-CIDR access for a replica set instance.

Debug

Querying Cross-CIDR Access Configuration of a Replica Set Instance

hcloud DDS ShowClientNetwork

This API is used to query cross-CIDR access configuration of a replica set instance.

Debug

Querying AZs to Which an Instance Can Be Migrated

hcloud DDS ListAz2Migrate

This API is used to query the AZs to which an instance can be migrated.

Debug

Migrating an Instance to Another AZ

hcloud DDS MigrateAz

This API is used to migrate an instance to another AZ.

Debug

Adding Read Replicas to an Instance

hcloud DDS AddReadonlyNode

This API is used to add read replicas to a DDS replica set instance.

Debug

Deleting Read Replicas

hcloud DDS DeleteReadonlyNode

This API is used to delete read replicas from a replica set instance.

Debug

Upgrading a Database Patch Version

hcloud DDS UpgradeDatabaseVersion

This API is used to upgrade a database patch version.

Debug

Enabling or Disabling Monitoring by Seconds

hcloud DDS SwitchSecondLevelMonitoring

This API is used to enable or disable Monitoring by Seconds for a specified instance.

Debug

Querying Monitoring by Seconds Configurations

hcloud DDS ShowSecondLevelMonitoringStatus

This API is used to query Monitoring by Seconds configurations.

Debug

Configuring the Maintenance Window

hcloud DDS ChangeOpsWindow

This API is used to modify the time range within which tasks impacting DB instance operations can be initiated, for example, the time window for upgrading the operating system and database software.

Debug

Setting the Recycle Bin Policy for an Instance

hcloud DDS SetRecyclePolicy

This API is used to set the recycle bin policy for an instance.

Debug

Querying the Recycling Policy of an Instance

hcloud DDS ShowRecyclePolicy

This API is used to query the recycling policy of an instance.

Debug

Querying Instances in the Recycle Bin

hcloud DDS ListRecycleInstances

This API is used to query instances in the recycle bin.

Debug

Checking for Weak Passwords

hcloud DDS CheckWeakPassword

This API is used to check whether a password is a weak password.

Debug

Querying the Estimated Database Patch Upgrade Duration

hcloud DDS ShowUpgradeDuration

This API is used to query the estimated database patch upgrade duration.

Debug

Querying Instance Storage Information

hcloud DDS ShowDiskUsage

This API is used to query storage information of an instance.

Debug

Obtaining the SSL Certificate Download Address

hcloud DDS ListSslCertDownloadAddress

This API is used to obtain the SSL certificate download address.

Debug

Adding Nodes to a Replica Set Instance

hcloud DDS ExpandReplicasetNode

This API is used to add nodes to a specified replica set instance.

Debug

Querying the Name of the Replica Set in the Connection Address

hcloud DDS ShowReplSetName

This API is used to query the name of the replica set in the connection address.

Debug

Changing the Name of the Replica Set in the Connection Address

hcloud DDS UpdateReplSetName

This API is used to change the name of the replica set in the connection address.

Debug

Configuring a Storage Autoscaling Policy

hcloud DDS SetAutoEnlargePolicies

This API is used to configure a storage autoscaling policy.

Debug

Deleting Instance Nodes

hcloud DDS ShrinkInstanceNodes

This API is used to delete nodes from an instance.

Debug

Querying LTS Log Configurations

hcloud DDS ListLtsConfigs

This API is used to query LTS log configurations.

Debug

Associating an Instance with an LTS Log Stream

hcloud DDS UpdateLtsConfig

After you have associated an instance with a Log Tank Service (LTS) log stream, logs of the instance are automatically uploaded to the associated LTS log stream.

Debug

Disassociating an Instance from an LTS Log Stream

hcloud DDS DeleteLtsConfig

After you have disassociated an instance from an LTS log stream, logs of the instance are not automatically uploaded to the associated LTS log stream.

Debug

Querying the Autoscaling Policy of Storage Space

hcloud DDS ShowAutoEnlargePolicy

This API is used to query the autoscaling policy of storage space.

Debug

Upgrading the Patch Versions of Instances in Batches

hcloud DDS BatchUpgradeDatabaseVersion

This API is used to upgrade the patch versions of instances in batches.

Debug

Deleting mongos Nodes

hcloud DDS DeleteMongosNode

This API is used to delete mongos nodes from a cluster instance.

Debug

Deleting Shard or Config IP Addresses of a Cluster Instance

hcloud DDS DeleteIp

This API is used to delete shard or config IP addresses of a cluster instance.

Debug

Deleting Shards

hcloud DDS BatchDeleteShards

This API is used to delete shards.

Debug

Connection Management

API

Command

Description

Operation

Querying Sessions of an Instance Node

hcloud DDS ListSessions

This API is used to query sessions of an instance node.

Debug

Killing Sessions of an Instance Node

hcloud DDS DeleteSession

This API is used to kill sessions of an instance node.

Debug

Querying the Number of Connections to an Instance

hcloud DDS ShowConnectionStatistics

This API is used to query the number of connections from client IP addresses to a DDS DB instance.

Debug

Backup and Restoration

API

Command

Description

Operation

Restoring Data to a New Instance

hcloud DDS RestoreNewInstance

This API is used to restore data to a new instance from backups.

Debug

Creating a Manual Backup

hcloud DDS CreateManualBackup

This API is used to create a manual backup for a DB instance.

Debug

Querying Backups

hcloud DDS ListBackups

This API is used to query backups based on specified conditions.

Debug

Deleting a Manual Backup

hcloud DDS DeleteManualBackup

This API is used to delete a manual backup from a DB instance.

Debug

Stopping a Backup

hcloud DDS StopBackup

This API is used to stop a backup in case of an emergency.

Debug

Configuring an Automated Backup Policy

hcloud DDS SetBackupPolicy

This API is used to configure an automated backup policy.

Debug

Querying an Automated Backup Policy

hcloud DDS ShowBackupPolicy

This API is used to query an automated backup policy.

Debug

Obtaining the Link for Downloading a Backup

hcloud DDS ShowBackupDownloadLink

This API is used to obtain the link for downloading a backup.

Debug

Querying the Restoration Time Range

hcloud DDS ListRestoreTimes

This API is used to query the restoration time range of an instance.

Debug

Obtaining the List of Databases That Can Be Restored

hcloud DDS ListRestoreDatabases

This API is used to obtain the list of databases that can be restored.

Debug

Obtaining the List of Database Collections That Can Be Restored

hcloud DDS ListRestoreCollections

This API is used to obtain the list of database collections that can be restored.

Debug

Restoring Data to the Original Instance

hcloud DDS RestoreInstance

This API is used to restore data to the original instance.

Debug

Restoring Databases and Tables to a Point in Time

hcloud DDS RestoreInstanceFromCollection

This API is used to restore databases and tables to a specified point in time.

Debug

Creating a Backup Download Policy

hcloud DDS SaveBackupDownloadPolicy

This API is used to create a backup download policy.

Debug

Updating a Backup Download Policy

hcloud DDS UpdateBackupDownloadPolicy

This API is used to update a backup download policy.

Debug

Querying a Backup Download Policy

hcloud DDS ListBackupDownloadPolicy

This API is used to query a backup download policy.

Debug

Deleting Manual Backups in Batches

hcloud DDS BatchDeleteBackup

This API is used to delete manual backups of a DB instance in batches.

Debug

Log Information Queries

API

Command

Description

Operation

Configuring SQL Audit

hcloud DDS SetAuditlogPolicy

This API is used to set a policy for SQL audit logs.

Debug

Querying a SQL Audit Policy

hcloud DDS ShowAuditlogPolicy

This API is used to query the policy for audit logs.

Debug

Obtaining Audit Logs

hcloud DDS ListAuditlogs

This API is used to obtain audit logs.

Debug

Deleting Audit Logs

hcloud DDS DeleteAuditLog

This API is used to delete audit logs.

Debug

Obtaining Links for Downloading Audit Logs

hcloud DDS ListAuditlogLinks

This API is used to obtain links for downloading audit logs.

Debug

Querying Slow Query Logs of a DB Instance

hcloud DDS ListSlowLogs

This API is used to query slow query logs of a DB instance.

Debug

Querying Slow Query Logs of a DB Instance

hcloud DDS ListLtsSlowLogs

This API is used to query slow query logs by keyword or database table name.

Debug

Obtaining Links for Downloading Slow Query Logs

hcloud DDS DownloadSlowlog

This API is used to obtain links for downloading slow query logs.

Debug

Querying Error Logs of a DB Instance

hcloud DDS ListErrorLogs

This API is used to query error logs of a DB instance.

Debug

Obtaining Links for Downloading Error Logs

hcloud DDS DownloadErrorlog

This API is used to obtain links for downloading error logs.

Debug

Configuring the Show Original Log Switch

hcloud DDS SwitchSlowlogDesensitization

This API is used to configure the Show Original Log switch for an instance.

Debug

Querying the Switch of Show Original Log

hcloud DDS ShowSlowlogDesensitizationSwitch

This API is used to check whether Show Original Log is enabled.

Debug

Querying Error Logs of a DB Instance

hcloud DDS ListLtsErrorLogs

This API is used to query error logs of a DB instance.

Debug

Tag Management

API

Command

Description

Operation

Querying Instances by Tag

hcloud DDS ListInstancesByTags

This API is used to query the specified instances by tag.

Debug

Adding or Deleting Resource Tags in Batches

hcloud DDS BatchTagAction

This API is used to add tags to or delete tags from a specified instance in batches.

Debug

Querying Tags of an Instance

hcloud DDS ListInstanceTags

This API is used to query tags of a specified instance.

Debug

Querying Tags of a Specified Project

hcloud DDS ListProjectTags

This API is used to query all tags of instances in a specified project.

Debug

Database and User Management

API

Command

Description

Operation

Creating a Database User

hcloud DDS CreateDatabaseUser

This API is used to create a database user.

Debug

Deleting a Database User

hcloud DDS DeleteDatabaseUser

This API is used to delete a database user.

Debug

Creating a Database Role

hcloud DDS CreateDatabaseRole

This API is used to create a database role.

Debug

Deleting a Database Role

hcloud DDS DeleteDatabaseRole

This API is used to delete a database role.

Debug

Querying Database Users

hcloud DDS ListDatabaseUsers

This API is used to query database users.

Debug

Querying Database Roles

hcloud DDS ListDatabaseRoles

This API is used to query database roles.

Debug

Changing the Password of a Database User

hcloud DDS ResetPassword

This API is used to change the password of a database user.

Debug

Checking a Database Password

hcloud DDS CheckPassword

This API is used to check a database password.

Debug

Querying Cluster Balancing Settings

hcloud DDS ShowShardingBalancer

This API is used to query the data balancing settings of a DDS cluster.

Debug

Enabling or Disabling Cluster Balancing

hcloud DDS SetBalancerSwitch

This API is used to enable or disable cluster balancing.

Debug

Setting the Activity Time Window for Cluster Balancing

hcloud DDS SetBalancerWindow

This API is used to set the activity time window for cluster balancing.

Debug

Querying Databases

hcloud DDS ListDatabases

This API is used to query databases.

Debug

Parameter Configuration

API

Command

Description

Operation

Obtaining Parameter Templates

hcloud DDS ListConfigurations

This API is used to obtain parameter templates, including all DDS default parameter templates and user-created parameter templates.

Debug

Creating a Parameter Template

hcloud DDS CreateConfiguration

This API is used to create a parameter template.

Debug

Deleting a Parameter Template

hcloud DDS DeleteConfiguration

This API is used to delete a specified parameter template.

Debug

Obtaining Details About a Parameter Template

hcloud DDS ShowConfigurationParameter

This API is used to obtain parameter details of a specified parameter template.

Debug

Modifying a Parameter Template

hcloud DDS UpdateConfigurationParameter

This API is used to modify a specified parameter template, including parameter names, descriptions, and values.

Debug

Applying a Parameter Template

hcloud DDS SwitchConfiguration

This API is used to apply a parameter template to a specified instance.

Debug

Obtaining Parameters of a Specified Instance

hcloud DDS ShowEntityConfiguration

This API is used to obtain information about parameters of a specified instance.

Debug

Modifying Parameters of a Specified Instance

hcloud DDS UpdateEntityConfiguration

This API is used to modify the parameters of a specified instance, including the parameter template of a DB instance, group, or node.

Debug

Checking Whether a Parameter Template Name Exists

hcloud DDS ValidateConfigurationName

This API is used to check whether a parameter template name exists.

Debug

Querying the Parameter Change History of an Instance

hcloud DDS ShowInstanceConfigurationModifyHistory

This API is used to query the change history of parameters of an instance.

Debug

Querying Available Instances

hcloud DDS ListAppliedInstances

This API is used to query instances that a specified parameter template can be applied to.

Debug

Querying Application Records of a Parameter Template

hcloud DDS ShowConfigurationAppliedHistory

This API is used to query application records of a parameter template.

Debug

Querying the Change History of a Parameter Template

hcloud DDS ShowConfigurationModifyHistory

This API is used to query the change history of a parameter template.

Debug

Comparing Parameter Templates

hcloud DDS CompareConfiguration

This API is used to compare two parameter templates.

Debug

Replicating a Parameter Template

hcloud DDS CopyConfiguration

This API is used to replicate a parameter template.

Debug

Resetting a Parameter Template

hcloud DDS ResetConfiguration

This API is used to reset a parameter template.

Debug

Quota Management

API

Command

Description

Operation

Querying Quotas

hcloud DDS ShowQuotas

This API is used to query the DDS resource quotas of a single tenant, including the single node instance quota, replica set instance quota, and cluster instance quota.

Debug

Task Management

API

Command

Description

Operation

Querying Tasks and Details

hcloud DDS ListTasks

This API is used to query tasks and details in the task center based on specified conditions.

Debug

Obtaining Information About a Task with a Specified ID

hcloud DDS ShowJobDetail

This API is used to obtain information about a task with a specified ID in the task center.

Debug

Querying Scheduled Tasks

hcloud DDS ListScheduledTasks

This API is used to query scheduled tasks based on specified conditions.

Debug

Canceling a Scheduled Task

hcloud DDS CancelScheduledTask

This API is used to cancel a scheduled task based on the task ID.

Debug

Database O&M

API

Command

Description

Operation

Obtaining the killOp Rule List

hcloud DDS ShowKillOpRuleRuleList

This API is used to obtain the killOp rule list.

Debug

Enabling or Disabling a killOp Rule

hcloud DDS UpdateKillOpRule

This API is used to enable or disable a killOp rule.

Debug

Creating a killOp Rule

hcloud DDS CreateKillOpRule

This API is used to create a killOp rule.

Debug

Deleting a killOp Rule

hcloud DDS DeleteKillOpRuleList

This API is used to delete a killOp rule.

Debug

Forcibly Promoting a Secondary Node to Primary

hcloud DDS SwitchInstancePrimary

This API is used to forcibly promote a secondary node of a replica set, shard node, or config node to primary.

Debug