CLI Command Reference
Cluster Management APIs
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Cluster Details | hcloud DWS ListClusterDetails | This API is used to query cluster details. | |
| Deleting a Cluster | hcloud DWS DeleteCluster | This API is used to delete clusters. All resources of the deleted cluster, including customer data, will be released. For data security, create a snapshot for the cluster that you want to delete before deleting the cluster. | |
| Resetting a Password | hcloud DWS ResetPassword | This API is used to reset the password of cluster administrator. | |
| Restarting a Cluster | hcloud DWS RestartCluster | This API is used to restart clusters. | |
| Creating a Cluster | hcloud DWS CreateCluster | This API is used to create clusters. | |
| Querying the Cluster List | hcloud DWS ListClusters | This API is used to query and display the cluster list. | |
| Querying the Supported Node Types | hcloud DWS ListNodeTypes | This API is used to query the node types supported by DWS. | |
| Encrypting a Cluster | hcloud DWS EncryptCluster | This API is used to convert a cluster to an encrypted cluster. Constraint: The minimum version that supports cluster encryption is 8.0.0. The minimum guestAgent version that supports cluster encryption is 8.3.0.200. | |
| Querying Cluster Encryption Information | hcloud DWS ShowClusterEncryptInfo | This API is used to query cluster encryption information. This function is not supported for unencrypted clusters, and the returned information is empty. Constraint: The minimum version that supports cluster encryption is 8.0.0. The minimum guestAgent version that supports cluster encryption is 8.3.0.200. | |
| Modifying the Cluster Timezone | hcloud DWS ModifyClusterTimezone | This API is used to modify the timezone of a cluster. This operation modifies the timezone of both the OS and the database. Constraint: Modifying the timezone depends on the guestAgent plugin installed on the cluster. The plugin version must be 8.3.0.202 or later. | |
| c | hcloud DWS ChangeSecurityGroup | This API is used to change cluster security. | |
| Query cluster specification details | hcloud DWS ShowClusterFlavor | Query the specification details used by the cluster | |
| Querying Dedicated Distributed Storage Pool List | hcloud DWS ListDssPools | Obtain the dedicated distributed storage pool list, including only the SSD dedicated resource pool information enabled by the user. | |
| Primary/Standby Recovery | hcloud DWS SwitchOverCluster | When the cluster status is "Unbalanced", some nodes have more primary instances, resulting in heavy load pressure. In this case, the cluster status is normal, but the overall performance is lower than that in the balanced state. You can perform a primary/standby recovery operation to switch the cluster status to "Available". | |
| Removing Read-Only | hcloud DWS CancelReadonlyCluster | When a cluster enters the read-only state, database-related operations cannot be performed. Users can remove the read-only status of the cluster on the management console. The read-only status may be triggered by excessively high disk usage. Therefore, you need to clean up or scale out cluster data. | |
| Querying Cluster List V2 | hcloud DWS ShowClusters | This interface is used to query and display the cluster list. | |
| Querying Cluster Topology Ring Node Information | hcloud DWS ListTopoRings | Query the cluster topology ring node information. | |
| Querying Resource Statistics | hcloud DWS ShowResourceStatistics | This interface is used to query resource statistics. | |
| Querying Cluster Enterprise Project Information | hcloud DWS ListTagsForResource | Query the enterprise project information of a specified cluster. | |
| Querying Disk Usage | hcloud DWS ShowClusterVolume | Query node disk usage information on the tenant side. | |
| Modifying Cluster Name | hcloud DWS ModifyClusterName | Modify cluster name. | |
| Querying Enterprise Project Information of All Clusters | hcloud DWS ListEps | Query the enterprise project information of all clusters. |
Snapshot Management APIs
| API Name | Command | Description | Operation |
|---|---|---|---|
| Creating a Snapshot | hcloud DWS CreateSnapshot | This API is used to create snapshots for a specified cluster. | |
| Querying the Snapshot List | hcloud DWS ListSnapshots | This API is used to query the snapshot list. | |
| Restoring a Cluster | hcloud DWS RestoreCluster | This API is used to restore clusters using the snapshot. | |
| Querying Snapshot Details | hcloud DWS ListSnapshotDetails | This API is used to query snapshot details by using the snapshot ID. | |
| Deleting a Manual Snapshot | hcloud DWS DeleteSnapshot | This API is used to delete a specified manual snapshot. |
Node Change
| API Name | Command | Description | Operation |
|---|---|---|---|
| Scaling Out Clusters | hcloud DWS ResizeCluster | This interface is used to expand the cluster and can also be used to add idle nodes. By default: it indicates performing an expansion operation. | |
| Issuing Redistribution | hcloud DWS ExecuteRedistributionCluster | This interface is used for data redistribution after cluster scale-out, evenly distributing old node data to the newly scaled-out nodes. After data "redistribution", the service response rate will be greatly improved. | |
| Scaling In Cluster | hcloud DWS ShrinkCluster | This interface is used to scale in a cluster. | |
| Querying Cluster CN Nodes | hcloud DWS ListClusterCn | Query the CN node list of a cluster. | |
| Batch Adding CN Nodes | hcloud DWS BatchCreateClusterCn | After a cluster is created, the actual number of CNs required changes with service requirements. Therefore, the CN node management function enables users to dynamically adjust the number of CNs based on actual requirements. | |
| Batch Deleting CN Nodes | hcloud DWS BatchDeleteClusterCn | After a cluster is created, the actual number of CNs required changes with service requirements. Therefore, the CN node management function enables users to dynamically adjust the number of CNs based on actual requirements. | |
| Querying Appropriate Scale-In Count | hcloud DWS ListClusterScaleInNumbers | Query the appropriate scale-in node count. | |
| Disk Scale-Out | hcloud DWS ExpandInstanceStorage | As the customer's service grows, disk space is often the first resource bottleneck. When other resources are still sufficient, disk scale-out can quickly alleviate the storage resource bottleneck. The operation does not require suspending services and does not waste resources such as CPU and memory. | |
| Scaling Out from Idle Nodes | hcloud DWS ResizeClusterWithExistedNodes | Scale out from idle nodes. | |
| Querying Node List | hcloud DWS ListClusterNodes | Query the node list. | |
| Resuming Redistribution | hcloud DWS RestoreRedistribution | Resume the redistribution operation in the suspended state. Only DWS 2.0 clusters are supported. | |
| Pausing Redistribution | hcloud DWS StopRedistribution | This interface is used to suspend the redistribution operation in the running state. In the suspended state, you can set redistribution priorities, modify the redistribution concurrency, and perform other operations. | |
| Deleting Idle Nodes | hcloud DWS DeleteClusterNodes | Delete idle nodes. | |
| Updating Redistribution Configuration | hcloud DWS UpdateRedistributionConfigurations | Update redistribution configuration. | |
| Updating Redistribution Table Priority | hcloud DWS SetRedistributionPriority | Update redistribution table priorities. | |
| Pre-Checking Cluster Scale-Out | hcloud DWS CheckGrowCluster | Pre-scale-out check for a cluster to identify scale-out failures caused by issues such as insufficient subnets or permissions. | |
| Pre-Checking Cluster Scale-In | hcloud DWS CheckClusterShrink | Pre-scale-in check to ensure both pre- and post-scale-in conditions meet normal operation requirements. | |
| Obtaining Schema Information of Tables to Be Redistributed | hcloud DWS ListRedistributionSchema | Obtain the schema information of tables to be redistributed. | |
| Querying List of Target Flavors Supporting Change | hcloud DWS ListTargetFlavors | Query the list of target specifications that support conversion. The flavor list returned by the interface contains at most 20 entries. | |
| Performing Flavor Change | hcloud DWS ExecuteFlavorChange | Perform flavor change. | |
| Querying Disk Scale-Out Range | hcloud DWS ShowClusterStorageExpandRange | This interface can be used to view the supported scale-out range for disk scale-out. | |
| Preparing for Cluster Scale-Out | hcloud DWS ResizePreparation | Configure the scale-out configuration file to complete preparation for scaling. | |
| Obtaining Scale-Out Preparation Information | hcloud DWS ShowResizePreparation | Obtain scale-out preparation information. | |
| Pre-Checking Disk Scale-Out | hcloud DWS CheckInstanceStorage | Pre-check before disk scale-out. |
Cluster Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| This API is used to query parameter modification audit records. | hcloud DWS ListConfigurationsAuditRecords | This API is used to query parameter modification audit records. | |
| This API is used to save cluster description. | hcloud DWS SaveClusterDescriptionInfo | This API is used to save cluster description. | |
| This API is used to query an instance. | hcloud DWS ShowInstance | This API is used to query an instance. | |
| Deleting a DWS Cluster | hcloud DWS DeleteDwsCluster | This API is used to delete a cluster. After a cluster is deleted, all resources of the cluster will be released, including customer data. For data security, create a snapshot for the cluster before deleting it. | |
| This API is used to query redistribution details. | hcloud DWS ShowClusterRedistribution | This API is used to query redistribution details. | |
| Starting a Cluster | hcloud DWS StartCluster | This API is used to start a cluster. | |
| Stopping a Cluster | hcloud DWS StopCluster | This API is used to stop a cluster. |
Upgrade Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| This API is used to deliver cluster upgrade operations. | hcloud DWS ExecuteClusterUpgradeAction | This API is used to deliver cluster upgrade operations. | |
| This API is used to obtain the target version to which a cluster can be upgraded. | hcloud DWS ListUpdatableVersion | This API is used to obtain the target version to which a cluster can be upgraded. | |
| This API is used to obtain the upgrade records of the current cluster. | hcloud DWS ListUpdateRecord | This API is used to obtain the upgrade records of the current cluster. |
Snapshot Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| This API is used to restore a table. | hcloud DWS RestoreTable | This API is used to restore a table. |
Data Source
Resource Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Enabling or Disabling Resource Management | hcloud DWS CreateClusterWorkload | This API is used to enable or disable resource management. By default, resource management is enabled for new clusters. | |
| Querying the Resource Management Switch Status | hcloud DWS ListClusterWorkload | This API is used to query the status of the resource management switch. | |
| Querying Resource Pools | hcloud DWS ListWorkloadQueue | This API is used to query resource pools. | |
| Adding a Resource Pool | hcloud DWS AddWorkloadQueue | This API is used to add a resource pool. | |
| This API is used to stop a workload plan. | hcloud DWS StopWorkloadPlan | This API is used to stop a workload plan. | |
| This API is used to query details about a workload plan. | hcloud DWS ShowWorkloadPlan | This API is used to query details about a workload plan. | |
| This API is used to delete a workload plan. | hcloud DWS DeleteWorkloadPlan | This API is used to delete a workload plan. | |
| This API is used to start a workload plan. | hcloud DWS StartWorkloadPlan | This API is used to start a workload plan. | |
| Adding a Workload Plan Stage | hcloud DWS AddWorkloadPlanStage | This API is used to add a workload plan stage. |
Logical Cluster Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Deleting Scheduled Addition and Deletion Plans for Logical Clusters. | hcloud DWS DeleteLogicalClusterPlan | This interface is used to delete a schedule for adding or deleting a logical cluster. | |
| Editing a Logical Cluster Add/Delete Plan. | hcloud DWS UpdateLogicalClusterPlan | This API is used to edit a logical cluster adding or deleting plan. | |
| Enabling Scheduled Adding and Deleting a Logical Cluster. | hcloud DWS EnableLogicalClusterPlan | Enabling Scheduled Adding and Deleting a Logical Cluster. | |
| Disabling Scheduled Adding and Deleting a Logical Cluster. | hcloud DWS DisableLogicalClusterPlan | Disabling Scheduled Adding and Deleting a Logical Cluster. | |
| Querying Scheduled Addition and Deletion Plans for Logical Clusters. | hcloud DWS ListLogicalClusterPlans | This interface is used to query scheduled addition and deletion plans of a logical cluster. | |
| Adding a Scheduled Addition or Deletion Plan for a Logical Cluster. | hcloud DWS CreateLogicalClusterPlan | This interface is used to add a scheduled adding or deleting plan for a logical cluster. | |
| Querying Logical Cluster Disk Information | hcloud DWS ListLogicalClusterVolumes | Query logical cluster disk information. | |
| Restarting Logical Cluster | hcloud DWS RestartLogicalCluster | Restart a logical cluster. | |
| Deleting Logical Cluster | hcloud DWS DeleteLogicalCluster | Delete a logical cluster. | |
| Editing Logical Cluster | hcloud DWS UpdateLogicalCluster | Edit and modify a logical cluster. The interface determines whether the current operation is a logical cluster scale-in or scale-out based on the submitted request body. | |
| Toggling Logical Cluster Switch | hcloud DWS EnableLogicalCluster | Toggle the logical cluster switch. This is used only to control whether the logical cluster function module is displayed on the page. | |
| Converting Physical Cluster to Logical Cluster | hcloud DWS ConvertToLogicalCluster | Convert a physical cluster to a logical cluster. | |
| Querying Logical Cluster Task Information | hcloud DWS ListLogicalClusterTasks | Query logical cluster task information. | |
| Creating Logical Cluster | hcloud DWS CreateLogicalCluster | Create a logical cluster using nodes in the elastic pool. This interface is no longer maintained and may be taken offline in later versions. The corresponding function of this interface has been taken offline in the new version. | |
| Querying Logical Cluster List | hcloud DWS ListLogicalClusters | Query the logical cluster list. | |
| Scaling In Logical Cluster | hcloud DWS ShrinkLogicalCluster | Scale in a logical cluster. Scaling in from a logical cluster and from an elastic pool are supported. | |
| Querying Available Ring Node Information of Logical Cluster | hcloud DWS ListLogicalClusterRings | Query available ring node information of a logical cluster. |
Audit logs
| API Name | Command | Description | Operation |
|---|---|---|---|
| This API is used to disable LTS for a cluster. | hcloud DWS DisableLtsLogs | This API is used to disable LTS for a cluster. | |
| This API is used to enable LTS for a cluster. | hcloud DWS EnableLtsLogs | This API is used to enable LTS for a cluster. | |
| This API is used to obtain the LTS log list. | hcloud DWS ListLtsLogs | This API is used to obtain the LTS log list. |
Host Monitoring
| API Name | Command | Description | Operation |
|---|---|---|---|
| This API is used to query the real-time SQL list. | hcloud DWS ListQueries | This API is used to query the real-time SQL list. | |
| This API is used to query the skew or dirty page rate of a table. | hcloud DWS ListTablesStatistic | Querying Table Skew or Dirty Page Rate Information. | |
| This API is used to query SQL execution information. | hcloud DWS ShowQueryDetail | This API is used to query SQL execution information. |
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
