CLI Command Reference (V1)

Creating a Cluster

hcloud CSS CreateCluster/v1

This API is used to create a cluster.

Go debug

Querying the Cluster List

hcloud CSS ListClustersDetails/v1

This API is used to query and display the cluster list and cluster status.

Go debug

Querying Cluster Details

hcloud CSS ShowClusterDetail/v1

This API is used to query and display the details of a cluster.

Go debug

Deleting a Cluster

hcloud CSS DeleteCluster/v1

This API is used to delete a cluster. All resources of the deleted cluster, including customer data, will be released. If you want to retain the data in a customer cluster, create a snapshot before deleting the cluster.

Go debug

Changing the Cluster Billing Mode from Pay-per-use to Yearly/Monthly

hcloud CSS UpdateOndemandClusterToPeriod/v1

This API is used to change the cluster billing mode from pay-per-use to yearly/monthly.

Go debug

Renaming a Cluster

hcloud CSS UpdateClusterName/v1

This API is used to change the name of a cluster.

Go debug

Changing the Password of a Cluster

hcloud CSS ResetPassword/v1

This API is used to change the password of a cluster.

Go debug

Restarting a Cluster

hcloud CSS RestartCluster/v1

This API is used to restart a cluster. Services will be interrupted during the restart.

Go debug

Scaling Out a Cluster

hcloud CSS UpdateExtendCluster/v1

This API is used to add instances to a cluster (only Elasticsearch instances can be added). This API can only scale out clusters that only have common nodes. Clusters with master, client, or cold data nodes cannot use this API.

Go debug

Adding Instances and Expanding Instance Storage Capacity

hcloud CSS UpdateExtendInstanceStorage/v1

This API is used to add instances of different types and expand instance storage capacity in a cluster. This API is available for clusters with master, client, or cold data nodes.

Go debug

Changing Node Specifications

hcloud CSS UpdateFlavor/v1

This API is used to modify the specifications of a cluster. Only the nodes of the ESS type can be modified.

Go debug

Querying All Tags

hcloud CSS ListClustersTags/v1

This API is used to query all tags in a specified region.

Go debug

Querying Tags of a Specified Cluster

hcloud CSS ShowClusterTag/v1

This API is used to query the tags of a specified cluster.

Go debug

Adding Tags to a Cluster

hcloud CSS CreateClustersTags/v1

This API is used to add tags to a cluster.

Go debug

Deleting a Cluster Tag

hcloud CSS DeleteClustersTags/v1

This API is used to delete a cluster tag.

Go debug

Adding or Deleting Cluster Tags in Batches

hcloud CSS UpdateBatchClustersTags/v1

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

Go debug

Changing the Specifications of a Specified Node Type

hcloud CSS UpdateFlavorByType/v1

This API is used to modify cluster specifications. The following node types can be changed:

Go debug

Scaling In a Cluster by Removing a Specific Node

hcloud CSS UpdateShrinkNodes/v1

This API is used to scale in a cluster by removing a specified node.

Go debug

Scaling In Nodes of a Specific Type

hcloud CSS UpdateShrinkCluster/v1

This API is used to remove instances of different types and reduce instance storage capacity in a cluster.

Go debug

Downloading a Security Certificate

hcloud CSS DownloadCert/v1

This API is used to download a security certificate.

Go debug

Replacing a Node

hcloud CSS UpdateInstance/v1

This API is used to replace a failed node.

Go debug

Configuring the Security Mode.

hcloud CSS ChangeMode/v1

This API is used to configure the security mode of a cluster.

Go debug

Adding Independent Masters and Clients

hcloud CSS AddIndependentNode/v1

If you have not enabled the master or client node when creating a cluster, you can call this API to add one.

Go debug

Upgrading a Cluster Kernel

hcloud CSS UpgradeCore/v1

This API is used to upgrade Elasticsearch from an earlier version to a later version or the same version.

Go debug

Obtain the upgradable target image ID

hcloud CSS ListImages/v1

This API is used to obtain the ID of an image that can be upgraded in the current cluster.

Go debug

Obtain detailed information on cluster upgrades or AZ switching.

hcloud CSS UpgradeDetail/v1

The upgrade takes a long time. You can call this API to check the upgrade progress on a node.

Go debug

Retrying a Failed Upgrade Task

hcloud CSS RetryUpgradeTask/v1

The upgrade may fail due to network problems. In this case, you can call this API to retry.

Go debug

Changing the Security Group

hcloud CSS ChangeSecurityGroup/v1

This API is used to change the security group after a cluster is created.

Go debug

Changing the AZ of a Cluster Instance

hcloud CSS UpdateAzByInstanceType/v1

This API is used to change the AZ by specifying node types.

Go debug

Switching Cluster Subnets

hcloud CSS ChangeClusterSubnet/v1

This interface can be used to bind new subnets to added nodes in scenarios such as switching cluster subnets, expanding clusters, or adding nodes after the cluster has been successfully created.

Go debug

Updating Cluster Routes

hcloud CSS UpdateRoute/v1

This interface is used to update cluster routing.

Go debug

Obtaining Cluster Routes

hcloud CSS ListRoutes/v1

This interface is used to obtain cluster routing information.

Go debug

Automatically create an agency.

hcloud CSS CreateAgency/v1

Automatically create an agency and assign necessary permissions when the CSS pre-configured agency does not exist.

Go debug

Query cluster disk usage.

hcloud CSS ShowClusterVolumeUsage/v1

Query disk usage of the cluster.

Go debug

Obtaining the Instance Specifications List

hcloud CSS ListFlavors/v1

This API is used to query and display the IDs of supported instance specifications.

Go debug

Query the list of changeable specifications for a specified cluster.

hcloud CSS ShowResizeFlavors/v1

Query the specifications to which a specified cluster can be changed.

Go debug

Query specification details.

hcloud CSS ShowFlavorDetail/v1

Query detailed information about a specification.

Go debug

Query specifications supported by a specified engine.

hcloud CSS ShowDataStoreFlavorDetail/v1

Query specifications supported by a specified engine.

Go debug

Lists disk types.

hcloud CSS ListDiskType/v1

Obtain the disk types supported by each AZ.

Go debug

Loading Custom Word Dictionaries

hcloud CSS CreateLoadIkThesaurus/v1

This API is used to load a custom word dictionary stored in OBS.

Go debug

Querying the Status of a Custom Word Dictionary

hcloud CSS ShowIkThesaurus/v1

This API is used to query the loading status of a custom word dictionary.

Go debug

Disabling a Word Dictionary

hcloud CSS DeleteIkThesaurus/v1

This API is used to delete custom word dictionaries.

Go debug

Enabling Kibana Public Access

hcloud CSS StartKibanaPublic/v1

This API is used to enable public network access to Kibana.

Go debug

Disabling Kibana Public Access

hcloud CSS UpdateCloseKibana/v1

This API is used to disable public network access to Kibana.Yearly/Monthly clusters cannot disable public access using APIs.

Go debug

Modifying the Kibana Public Network Bandwidth

hcloud CSS UpdateAlterKibana/v1

This API is used to modify the public network bandwidth of Kibana.

Go debug

Modifying Kibana Public Access Control

hcloud CSS UpdatePublicKibanaWhitelist/v1

This API is used to modify the Kibana access permission by modifying the Kibana whitelist.

Go debug

Disabling Kibana Public Network Access Control

hcloud CSS StopPublicKibanaWhitelist/v1

This API is used to disable public network access control for Kibana.

Go debug

Creating a Configuration File

hcloud CSS CreateCnf/v1

This API is used to create a configuration file.

Go debug

Updating a Configuration File

hcloud CSS UpdateCnf/v1

This API is used to update a configuration file.

Go debug

Starting Pipeline Data Migration

hcloud CSS StartPipeline/v1

This API is used to start pipeline data migration.

Go debug

Stopping Pipeline Data Migration

hcloud CSS StopPipeline/v1

This API is used to stop pipeline data migration.

Go debug

Adding a Custom Template

hcloud CSS AddFavorite/v1

This API is used to add a custom template.

Go debug

Performing a Connectivity Test

hcloud CSS StartConnectivityTest/v1

This API is used to test connectivity.

Go debug

Querying the Template List

hcloud CSS ListTemplates/v1

This API is used to query the template list.

Go debug

Querying the Configuration File List

hcloud CSS ListConfs/v1

This API is used to query the configuration file list.

Go debug

Querying the Pipeline List

hcloud CSS ListPipelines/v1

This API is used to query the pipeline list.

Go debug

Querying Operation Records

hcloud CSS ListActions/v1

This API is used to query operation records.

Go debug

Querying the Configuration File Content

hcloud CSS ShowGetConfDetail/v1

This API is used to query the configuration file content.

Go debug

Deleting a Configuration File

hcloud CSS DeleteConf/v1

This API is used to delete a configuration file.

Go debug

Deleting a Custom Template

hcloud CSS DeleteTemplate/v1

This API is used to delete a custom template.

Go debug

Hot start pipeline to migrate data.

hcloud CSS StartHotPipeline/v1

This interface is used for hot-starting pipeline data migration.

Go debug

Hot stop pipeline data migration.

hcloud CSS StopHotPipeline/v1

This interface is used to hot-stop pipeline data migration.

Go debug

Uploading a Certificate File

hcloud CSS UploadCerts/v1

This interface is used for uploading certificate files.

Go debug

Querying the Certificate List

hcloud CSS ListCerts/v1

This interface is used to query the certificate list.

Go debug

Querying Certificate File Information

hcloud CSS ShowCertsDetail/v1

This interface is used to query certificate file information.

Go debug

Deleting a Certificate File

hcloud CSS DeleteCerts/v1

This interface is used to delete certificate files.

Go debug

Forcibly restart cluster VMs

hcloud CSS RebootCluster/v1

The cluster will be unavailable during the restart process. Please proceed with caution. For clusters that are currently in operation, the restart process will automatically stop the Logstash process. If the "Keep Alive" setting for the pipeline list is set to "No," all running pipelines will be set to a stopped state. If the "Keep Alive" setting is set to "Yes," it will trigger the Logstash process recovery mechanism, setting the status of the pipelines to "Recovering." If the Logstash process is restarted within ten minutes, the pipeline status will return to "Working"; otherwise, it will be set to "Failed.

Go debug

Enable log backup or log collection function

hcloud CSS StartLogs/v1

This interface is used to enable or disable the log backup or log collection function for the cluster.

Go debug

Disabling the Log Function

hcloud CSS StopLogs/v1

This API is used to disable the log function.

Go debug

Querying the Job List

hcloud CSS ListLogsJob/v1

This API is used to query the job list in the logs of a cluster.

Go debug

Querying Basic Log Configurations

hcloud CSS ShowGetLogSetting/v1

This API is used to query basic log configurations.

Go debug

Modifying Basic Log Configurations

hcloud CSS UpdateLogSetting/v1

This API is used to modify basic log configurations.

Go debug

Enabling the Automatic Log Backup Policy

hcloud CSS StartLogAutoBackupPolicy/v1

This API is used to enable the automatic log backup policy.

Go debug

Disabling the Automatic Log Backup Policy

hcloud CSS StopLogAutoBackupPolicy/v1

This API is used to disable the automatic log backup policy.

Go debug

Backing Up Logs

hcloud CSS CreateLogBackup/v1

This API is used to back up logs.

Go debug

Searching for Logs

hcloud CSS ShowLogBackup/v1

This API is used to query log information.

Go debug

Connectivity testing.

hcloud CSS StartTargetClusterConnectivityTest/v1

This interface is used for connectivity testing.

Go debug

Enabling Public Network Access

hcloud CSS CreateBindPublic/v1

This API is used to enable public network access.

Go debug

Disabling Public Network Access

hcloud CSS UpdateUnbindPublic/v1

This API is used to disable public network access to Kibana.Yearly/Monthly clusters cannot disable Kibana public access using APIs.

Go debug

Modifying Public Network Access Bandwidth

hcloud CSS UpdatePublicBandWidth/v1

This API is used to modify the public network access bandwidth.

Go debug

Enabling the Public Network Access Control Whitelist

hcloud CSS StartPublicWhitelist/v1

This API is used to enable the public network access control whitelist.

Go debug

Disabling the Public Network Access Control Whitelist

hcloud CSS StopPublicWhitelist/v1

This API is used to disable the public network access control whitelist.

Go debug

Automatically Setting Basic Configurations of a Cluster Snapshot

hcloud CSS StartAutoSetting/v1

This API is used to automatically set basic configurations for a cluster snapshot, including configuring OBS buckets and IAM agency.

Go debug

Modifying Basic Configurations of a Cluster Snapshot

hcloud CSS UpdateSnapshotSetting/v1

This API is used to modify the basic configurations for a cluster snapshot, including OBS buckets and IAM agency.

Go debug

Manually Creating a Snapshot

hcloud CSS CreateSnapshot/v1

This API is used to manually create a snapshot.

Go debug

Restoring a Snapshot

hcloud CSS RestoreSnapshot/v1

This API is used to manually restore a snapshot.

Go debug

Deleting a Snapshot

hcloud CSS DeleteSnapshot/v1

This API is used to delete a snapshot.

Go debug

Configuring the Automatic Snapshot Creation Policy

hcloud CSS CreateAutoCreatePolicy/v1

This API is used to configure automatic snapshot creation. By default, a snapshot is created every day.

Go debug

Querying the Automatic Snapshot Creation Policy

hcloud CSS ShowAutoCreatePolicy/v1

This API is used to query the automatic snapshot creation policy.

Go debug

Querying a Snapshot List

hcloud CSS ListSnapshots/v1

This API is used to query all the snapshots of a cluster.

Go debug

Disabling the Snapshot Function

hcloud CSS StopSnapshot/v1

This API is used to disable the snapshot function.

Go debug

Enabling the VPC Endpoint Service

hcloud CSS StartVpecp/v1

This API is used to enable the VPC endpoint service.

Go debug

Disabling the VPC Endpoint Service

hcloud CSS StopVpecp/v1

This API is used to disable the VPC endpoint service.

Go debug

Obtaining an Endpoint Connection

hcloud CSS ShowVpcepConnection/v1

This API is used to obtain a VPC endpoint connection.

Go debug

Updating an Endpoint Connection

hcloud CSS UpdateVpcepConnection/v1

This API is used to update an endpoint connection.

Go debug

Modifying the Endpoint Service Whitelist

hcloud CSS UpdateVpcepWhitelist/v1

This API is used to modify the endpoint service whitelist.

Go debug

Modifying Cluster Parameters

hcloud CSS UpdateYmls/v1

This API is used to modify the parameter settings of a cluster.

Go debug

Obtaining the Task List of Parameter Configurations

hcloud CSS ListYmlsJob/v1

This API is used to obtain the parameter configuration task list of a cluster.

Go debug

Obtaining the Parameter Configuration List

hcloud CSS ListYmls/v1

This API is used to obtain the parameter configuration list of the current cluster.

Go debug

Query the ELBv3 load balancers supported by the cluster

hcloud CSS ListElbs/v1

Display the ELBv3 load balancers supported by the query cluster.

Go debug

Enable or disable the load balancer for the cluster

hcloud CSS EnableOrDisableElb/v1

This interface enables or disables the load balancer for the cluster.

Go debug

ES listener configuration.

hcloud CSS CreateElbListener/v1

This interface is used for configuring the ES listener.

Go debug

Retrieve the load balancer information of the cluster

hcloud CSS ShowElbDetail/v1

This interface is used to retrieve the load balancer information of the cluster.

Go debug

Update Cluster Load Balancer Listener

hcloud CSS UpdateEsListener/v1

This interface is used to update the cluster load balancer listener.

Go debug

Querying the Certificate List

hcloud CSS ListElbCerts/v1

This interface is used to query the certificate list.

Go debug

Obtaining the Intelligent O&M Task List and Details

hcloud CSS ListAiOps/v1

CSS provides intelligent O&M functions to detect potential risks in clusters. After the detection task is complete, you can view details about the risk items of the cluster and handle the risks in a timely manner based on the risk suggestions. This interface is used to obtain the intelligent O&M task list and details.

Go debug

Create a cluster detection task.

hcloud CSS CreateAiOps/v1

This interface is used to create a cluster detection task.

Go debug

Delete a detection task record.

hcloud CSS DeleteAiOps/v1

This interface is used to delete a detection task record.

Go debug

Obtaining Available SMN Topics

hcloud CSS ListSmnTopics/v1

This API is used to obtain available SMN topics for intelligent O&M alarms.

Go debug

Viewing Intelligent O&M Detection Items

hcloud CSS ShowAiOpsDetector/v1

CSS provides intelligent O&M functions to detect potential risks in clusters. This API is used to obtain intelligent O&M detection items.

Go debug

Viewing Scheduled Intelligent O&M Detection Settings

hcloud CSS ShowAiOpsSetting/v1

CSS provides the intelligent O&M function to periodically detect potential risks in clusters every day. This interface is used to obtain the scheduled detection settings of intelligent O&M.

Go debug

Updating Scheduled Intelligent O&M Detection Settings

hcloud CSS UpdateAiOpsSetting/v1

CSS provides the intelligent O&M function to periodically detect potential risks in clusters every day. This interface is used to set scheduled intelligent O&M detection.

Go debug

Disabling Scheduled Intelligent O&M Detection

hcloud CSS CloseAiOpsSetting/v1

CSS provides the intelligent O&M function to periodically detect potential risks in clusters every day. This interface is used to disable scheduled intelligent O&M detection.

Go debug