CLI Command Reference
API Version Queries
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. | |
| Querying All Instance Specifications | hcloud DDS ListFlavors | This API is used to query all instance specifications under a specified condition. | |
| Querying Database Specifications | hcloud DDS ListFlavorInfos | This API is used to query instance specifications under a specified condition. | |
| Querying Database Storage Types | hcloud DDS ListStorageType | This API is used to query the database storage type in the current region. |
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. | |
| Querying Instances and Details | hcloud DDS ListInstances | This API is used to query instances and details based on specified conditions. | |
| Restarting an Instance | hcloud DDS RestartInstance | This API is used to restart an instance. | |
| Deleting an Instance | hcloud DDS DeleteInstance | This API is used to delete an instance. | |
| Changing an Instance Description | hcloud DDS UpdateInstanceRemark | This API is used to modify the description of an instance. | |
| Scaling Up Storage Space | hcloud DDS ResizeInstanceVolume | This API is used to scale up the storage space of an instance. | |
| Adding Nodes for a Cluster Instance | hcloud DDS AddShardingNode | This API is used to add nodes for a specified cluster instance. | |
| Changing Instance Specifications | hcloud DDS ResizeInstance | This API is used to change specifications of an instance. | |
| Performing a Primary/Secondary Switchover | hcloud DDS SwitchoverReplicaSet | This API is used to perform a primary/secondary switchover for an instance. | |
| Enabling or Disabling SSL | hcloud DDS SwitchSsl | This API is used to enable or disable SSL for an instance. | |
| Changing an Instance Name | hcloud DDS UpdateInstanceName | This API is used to change the name of an instance. | |
| Changing a Database Port | hcloud DDS UpdateInstancePort | This API is used to change the database port of an instance. | |
| Changing the Security Group of an Instance | hcloud DDS UpdateSecurityGroup | This API is used to change the security group associated with an instance. | |
| Binding an EIP | hcloud DDS AttachEip | This API is used to bind an EIP to a node in an instance. | |
| Unbinding an EIP | hcloud DDS CancelEip | This API is used to unbind an EIP from a node in an instance. | |
| Binding a Public Gateway | hcloud DDS BindPublicGateway | This API is used to bind a public gateway to a node in an instance. | |
| Unbinding a Public Gateway | hcloud DDS UnbindPublicGateway | This API is used to unbind a public gateway from a node in an instance. | |
| Changing the Private IP Address of an Instance | hcloud DDS AttachInternalIp | This API is used to change the private IP address of an instance. | |
| 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. | |
| 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. | |
| 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. | |
| 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. | |
| Migrating an Instance to Another AZ | hcloud DDS MigrateAz | This API is used to migrate an instance to another AZ. | |
| Adding Read Replicas to an Instance | hcloud DDS AddReadonlyNode | This API is used to add read replicas to a DDS replica set instance. | |
| Deleting Read Replicas | hcloud DDS DeleteReadonlyNode | This API is used to delete read replicas from a replica set instance. | |
| Upgrading a Database Patch Version | hcloud DDS UpgradeDatabaseVersion | This API is used to upgrade a database patch version. | |
| Enabling or Disabling Monitoring by Seconds | hcloud DDS SwitchSecondLevelMonitoring | This API is used to enable or disable Monitoring by Seconds for a specified instance. | |
| Querying Monitoring by Seconds Configurations | hcloud DDS ShowSecondLevelMonitoringStatus | This API is used to query Monitoring by Seconds configurations. | |
| 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. | |
| Setting the Recycle Bin Policy for an Instance | hcloud DDS SetRecyclePolicy | This API is used to set the recycle bin policy for an instance. | |
| Querying the Recycling Policy of an Instance | hcloud DDS ShowRecyclePolicy | This API is used to query the recycling policy of an instance. | |
| Querying Instances in the Recycle Bin | hcloud DDS ListRecycleInstances | This API is used to query instances in the recycle bin. | |
| Checking for Weak Passwords | hcloud DDS CheckWeakPassword | This API is used to check whether a password is a weak password. | |
| Querying the Estimated Database Patch Upgrade Duration | hcloud DDS ShowUpgradeDuration | This API is used to query the estimated database patch upgrade duration. | |
| Querying Instance Storage Information | hcloud DDS ShowDiskUsage | This API is used to query storage information of an instance. | |
| Obtaining the SSL Certificate Download Address | hcloud DDS ListSslCertDownloadAddress | This API is used to obtain the SSL certificate download address. | |
| Adding Nodes to a Replica Set Instance | hcloud DDS ExpandReplicasetNode | This API is used to add nodes to a specified replica set instance. | |
| 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. | |
| 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. | |
| Configuring a Storage Autoscaling Policy | hcloud DDS SetAutoEnlargePolicies | This API is used to configure a storage autoscaling policy. | |
| Deleting Instance Nodes | hcloud DDS ShrinkInstanceNodes | This API is used to delete nodes from an instance. | |
| Querying LTS Log Configurations | hcloud DDS ListLtsConfigs | This API is used to query LTS log configurations. | |
| 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. | |
| 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. | |
| Querying the Autoscaling Policy of Storage Space | hcloud DDS ShowAutoEnlargePolicy | This API is used to query the autoscaling policy of storage space. | |
| Upgrading the Patch Versions of Instances in Batches | hcloud DDS BatchUpgradeDatabaseVersion | This API is used to upgrade the patch versions of instances in batches. | |
| Deleting mongos Nodes | hcloud DDS DeleteMongosNode | This API is used to delete mongos nodes from a cluster instance. | |
| 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. | |
| Deleting Shards | hcloud DDS BatchDeleteShards | This API is used to delete shards. |
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. | |
| Killing Sessions of an Instance Node | hcloud DDS DeleteSession | This API is used to kill sessions of an instance node. | |
| 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. |
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. | |
| Creating a Manual Backup | hcloud DDS CreateManualBackup | This API is used to create a manual backup for a DB instance. | |
| Querying Backups | hcloud DDS ListBackups | This API is used to query backups based on specified conditions. | |
| Deleting a Manual Backup | hcloud DDS DeleteManualBackup | This API is used to delete a manual backup from a DB instance. | |
| Stopping a Backup | hcloud DDS StopBackup | This API is used to stop a backup in case of an emergency. | |
| Configuring an Automated Backup Policy | hcloud DDS SetBackupPolicy | This API is used to configure an automated backup policy. | |
| Querying an Automated Backup Policy | hcloud DDS ShowBackupPolicy | This API is used to query an automated backup policy. | |
| Obtaining the Link for Downloading a Backup | hcloud DDS ShowBackupDownloadLink | This API is used to obtain the link for downloading a backup. | |
| Querying the Restoration Time Range | hcloud DDS ListRestoreTimes | This API is used to query the restoration time range of an instance. | |
| 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. | |
| 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. | |
| Restoring Data to the Original Instance | hcloud DDS RestoreInstance | This API is used to restore data to the original instance. | |
| 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. | |
| Creating a Backup Download Policy | hcloud DDS SaveBackupDownloadPolicy | This API is used to create a backup download policy. | |
| Updating a Backup Download Policy | hcloud DDS UpdateBackupDownloadPolicy | This API is used to update a backup download policy. | |
| Querying a Backup Download Policy | hcloud DDS ListBackupDownloadPolicy | This API is used to query a backup download policy. | |
| Deleting Manual Backups in Batches | hcloud DDS BatchDeleteBackup | This API is used to delete manual backups of a DB instance in batches. |
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. | |
| Querying a SQL Audit Policy | hcloud DDS ShowAuditlogPolicy | This API is used to query the policy for audit logs. | |
| Obtaining Audit Logs | hcloud DDS ListAuditlogs | This API is used to obtain audit logs. | |
| Deleting Audit Logs | hcloud DDS DeleteAuditLog | This API is used to delete audit logs. | |
| Obtaining Links for Downloading Audit Logs | hcloud DDS ListAuditlogLinks | This API is used to obtain links for downloading audit logs. | |
| Querying Slow Query Logs of a DB Instance | hcloud DDS ListSlowLogs | This API is used to query slow query logs of a DB instance. | |
| 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. | |
| Obtaining Links for Downloading Slow Query Logs | hcloud DDS DownloadSlowlog | This API is used to obtain links for downloading slow query logs. | |
| Querying Error Logs of a DB Instance | hcloud DDS ListErrorLogs | This API is used to query error logs of a DB instance. | |
| Obtaining Links for Downloading Error Logs | hcloud DDS DownloadErrorlog | This API is used to obtain links for downloading error logs. | |
| Configuring the Show Original Log Switch | hcloud DDS SwitchSlowlogDesensitization | This API is used to configure the Show Original Log switch for an instance. | |
| Querying the Switch of Show Original Log | hcloud DDS ShowSlowlogDesensitizationSwitch | This API is used to check whether Show Original Log is enabled. | |
| Querying Error Logs of a DB Instance | hcloud DDS ListLtsErrorLogs | This API is used to query error logs of a DB instance. |
Tag Management
| API | Command | Description | Operation |
|---|---|---|---|
| Querying Instances by Tag | hcloud DDS ListInstancesByTags | This API is used to query the specified instances by tag. | |
| 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. | |
| Querying Tags of an Instance | hcloud DDS ListInstanceTags | This API is used to query tags of a specified instance. | |
| Querying Tags of a Specified Project | hcloud DDS ListProjectTags | This API is used to query all tags of instances in a specified project. |
Database and User Management
| API | Command | Description | Operation |
|---|---|---|---|
| Creating a Database User | hcloud DDS CreateDatabaseUser | This API is used to create a database user. | |
| Deleting a Database User | hcloud DDS DeleteDatabaseUser | This API is used to delete a database user. | |
| Creating a Database Role | hcloud DDS CreateDatabaseRole | This API is used to create a database role. | |
| Deleting a Database Role | hcloud DDS DeleteDatabaseRole | This API is used to delete a database role. | |
| Querying Database Users | hcloud DDS ListDatabaseUsers | This API is used to query database users. | |
| Querying Database Roles | hcloud DDS ListDatabaseRoles | This API is used to query database roles. | |
| Changing the Password of a Database User | hcloud DDS ResetPassword | This API is used to change the password of a database user. | |
| Checking a Database Password | hcloud DDS CheckPassword | This API is used to check a database password. | |
| Querying Cluster Balancing Settings | hcloud DDS ShowShardingBalancer | This API is used to query the data balancing settings of a DDS cluster. | |
| Enabling or Disabling Cluster Balancing | hcloud DDS SetBalancerSwitch | This API is used to enable or disable cluster balancing. | |
| Setting the Activity Time Window for Cluster Balancing | hcloud DDS SetBalancerWindow | This API is used to set the activity time window for cluster balancing. | |
| Querying Databases | hcloud DDS ListDatabases | This API is used to query databases. |
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. | |
| Creating a Parameter Template | hcloud DDS CreateConfiguration | This API is used to create a parameter template. | |
| Deleting a Parameter Template | hcloud DDS DeleteConfiguration | This API is used to delete a specified parameter template. | |
| Obtaining Details About a Parameter Template | hcloud DDS ShowConfigurationParameter | This API is used to obtain parameter details of a specified parameter template. | |
| Modifying a Parameter Template | hcloud DDS UpdateConfigurationParameter | This API is used to modify a specified parameter template, including parameter names, descriptions, and values. | |
| Applying a Parameter Template | hcloud DDS SwitchConfiguration | This API is used to apply a parameter template to a specified instance. | |
| Obtaining Parameters of a Specified Instance | hcloud DDS ShowEntityConfiguration | This API is used to obtain information about parameters of a specified instance. | |
| 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. | |
| Checking Whether a Parameter Template Name Exists | hcloud DDS ValidateConfigurationName | This API is used to check whether a parameter template name exists. | |
| 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. | |
| Querying Available Instances | hcloud DDS ListAppliedInstances | This API is used to query instances that a specified parameter template can be applied to. | |
| Querying Application Records of a Parameter Template | hcloud DDS ShowConfigurationAppliedHistory | This API is used to query application records of a parameter template. | |
| Querying the Change History of a Parameter Template | hcloud DDS ShowConfigurationModifyHistory | This API is used to query the change history of a parameter template. | |
| Comparing Parameter Templates | hcloud DDS CompareConfiguration | This API is used to compare two parameter templates. | |
| Replicating a Parameter Template | hcloud DDS CopyConfiguration | This API is used to replicate a parameter template. | |
| Resetting a Parameter Template | hcloud DDS ResetConfiguration | This API is used to reset a parameter template. |
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. |
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. | |
| 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. | |
| Querying Scheduled Tasks | hcloud DDS ListScheduledTasks | This API is used to query scheduled tasks based on specified conditions. | |
| Canceling a Scheduled Task | hcloud DDS CancelScheduledTask | This API is used to cancel a scheduled task based on the task ID. |
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. | |
| Enabling or Disabling a killOp Rule | hcloud DDS UpdateKillOpRule | This API is used to enable or disable a killOp rule. | |
| Creating a killOp Rule | hcloud DDS CreateKillOpRule | This API is used to create a killOp rule. | |
| Deleting a killOp Rule | hcloud DDS DeleteKillOpRuleList | This API is used to delete a killOp rule. | |
| 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. |
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot