CLI Command Reference

Hibernating a Cluster

hcloud CCE HibernateCluster

This API is used to hibernate a running cluster. After a cluster is hibernated, master node resources stop being billed.

Go debug

Waking Up a Cluster

hcloud CCE AwakeCluster

This API is used to wake up a hibernated cluster. After the cluster is woken up, master node resources continue to be billed.

Go debug

Obtaining a Cluster Certificate

hcloud CCE CreateKubernetesClusterCert

This API is used to obtain a certificate of a specified cluster.

Go debug

Revoking a Cluster Certificate of a User

hcloud CCE RevokeKubernetesClusterCert

This API is used to revoke a certificate of a specified cluster.

Go debug

Rotating the Cluster Certificate of a User

hcloud CCE RotateClusterCredentials

This API is used to rotate certificates of a specified cluster.

Go debug

Listing Clusters in a Specified Project

hcloud CCE ListClusters

This API is used to obtain details about all clusters in a specified project.

Go debug

Creating a Cluster

hcloud CCE CreateCluster

This API is used to create an empty cluster, which has only master nodes but no worker nodes. After creating a cluster by calling this API, you can add nodes by creating nodes.

Go debug

Reading a Specified Cluster

hcloud CCE ShowCluster

This API is used to obtain details about a specified cluster.

Go debug

Updating a Specified Cluster

hcloud CCE UpdateCluster

This API is used to update information about a specified cluster.

Go debug

Deleting a Cluster

hcloud CCE DeleteCluster

This API is used to delete a specified cluster.

Go debug

Modifying Cluster Specifications

hcloud CCE ResizeCluster

This API is used to modify the specifications of a cluster.

Go debug

Querying a Job

hcloud CCE ShowJob

This API is used to obtain information about a job via the job ID returned after a query request is delivered.

Go debug

Binding/Unbinding Public API Server Address

hcloud CCE UpdateClusterEip

This API is used to bind or unbind the public API server address of the cluster by cluster ID.

Go debug

Obtaining Cluster Access Address

hcloud CCE ShowClusterEndpoints

This API is used to obtain the cluster access addresses by cluster ID, including the private IP (VIP returned by an HA cluster) and public IP.

Go debug

Obtaining the Global OBS Access Secret of a Cluster

hcloud CCE GetClusterLongAkskConfig

This API is used to obtain the global OBS access secret of a cluster.

Go debug

Updating the Global OBS Access Secret of a Cluster

hcloud CCE UpdateClusterLongAkskConfig

This API is used to update the global OBS access secret of a cluster.

Go debug

Obtaining the Global OBS Access Secret of a Project

hcloud CCE GetLongAkskConfig

This API is used to obtain the global OBS access secret of a project.

Go debug

Updating the Global OBS Access Secret of a Project

hcloud CCE UpdateLongAkskConfig

This API is used to update the global OBS access secret of a project.

Go debug

Obtaining Available Cluster Flavors

hcloud CCE GetClusterFlavorSpecs

This API is used to obtain the available cluster flavors.

Go debug

Obtaining the Feature Gate Status

hcloud CCE ShowFeatureGates

This API is used to obtain the feature gate status.

Go debug

Obtaining a Cluster's Logging Configurations

hcloud CCE ShowClusterConfig

This API is used to obtain LTS configurations reported by the cluster components.

Go debug

Configuring Cluster Logs

hcloud CCE UpdateClusterLogConfig

This API is used to select the master node components whose logs are reported to LTS.

Go debug

Obtaining the AZ List

hcloud CCE GetAvaliableZone

This API is used to obtain the AZ list.

Go debug

Obtaining Cluster Quotas

hcloud CCE GetClusterQuota

This API is used to obtain the cluster quotas.

Go debug

Obtaining Partition Details

hcloud CCE ShowPartition

This API is used to obtain partition details.

Go debug

Updating a Partition

hcloud CCE UpdatePartition

This API is used to update a partition.

Go debug

Obtaining the Partition List

hcloud CCE ListPartitions

This API is used to obtain the partition list.

Go debug

Creating a Partition

hcloud CCE CreatePartition

This API is used to create a partition.

Go debug

Listing All Nodes in a Cluster

hcloud CCE ListNodes

This API is used to obtain details about all nodes in a specified cluster with the cluster ID.

Go debug

Creating a Node

hcloud CCE CreateNode

This API is used to create a node in a specified cluster.

Go debug

Reading a Specified Node

hcloud CCE ShowNode

This API is used to obtain details about a specified node via the node ID.

Go debug

Updating a Specified Node

hcloud CCE UpdateNode

This API is used to update information about a specified node.

Go debug

Deleting a Node

hcloud CCE DeleteNode

This API is used to delete a specified node.

Go debug

Accepting a Node

hcloud CCE AddNode

This API is used to accept a node into a specified cluster.

Go debug

Rotating node certificates

hcloud CCE RotateNodeCert

This API is used to rotate node certificates in a specified cluster. Compensation mechanism for cluster certificate rotation: When the matching cluster certificate rotation API is used to rotate certificates, if the certificates of some nodes fail to be rotated, you can call this API to retry.

Go debug

Resetting a Node

hcloud CCE ResetNode

This API is used to reset a node in a specified cluster.

Go debug

Removing a Node

hcloud CCE RemoveNode

This API is used to remove a node from a specified cluster.

Go debug

Enabling Scale-In Protection for a Node.

hcloud CCE LockNodepoolNodeScaleDown

This API is used to enable scale-in protection for a node. A node with scale-in protection enabled cannot be removed by simply changing the number of nodes in the node pool.

Go debug

Disabling Scale-In Protection for a Node.

hcloud CCE UnlockNodepoolNodeScaleDown

This API is used to disable scale-in protection for a node. A node with scale-in protection disabled can be removed by changing the number of nodes in the node pool. Scale-in protection can be disabled only for pay-per-use nodes.

Go debug

Migrating a Node

hcloud CCE MigrateNode

This API is used to migrate a node from a specified cluster to another cluster.

Go debug

Changing the Billing Mode of a Node to Yearly/Monthly

hcloud CCE BatchChangeNodeToPeriod

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

Go debug

Migrating a Node to a Custom Node Pool

hcloud CCE MigrateToNodePool

This API is used to migrate a node to a custom node pool. Only nodes in the default node pool can be migrated. Throughout the migration process, the node will remain unaffected and will not require resetting or restarting. Additionally, the original password will be preserved.

Go debug

sync node

hcloud CCE SyncNode

This API is used to synchronize nodes.

Go debug

Synchronizing Nodes in Batches

hcloud CCE BatchSyncNodes

This API is used to synchronize nodes in batches.

Go debug

Obtaining the Supernode List in a Cluster

hcloud CCE ListHyperNodes

This API is used to obtain details about all supernodes in a specified cluster.

Go debug

Managing a Node in a Customized Node Pool

hcloud CCE AddNodesToNodePool

This API is used to manage a node in a customized node pool of a cluster. Spot instances are not supported.

Go debug

Listing All Node Pools in a Specified Cluster

hcloud CCE ListNodePools

This API is used to obtain information about all node pools in a specified cluster.

Go debug

Creating a Node Pool

hcloud CCE CreateNodePool

This API is used to create a node pool in a specified cluster. This API can be called only when the cluster is in the available, scaling-out, or scaling-in state.

Go debug

Reading a Specified Node Pool

hcloud CCE ShowNodePool

This API is used to obtain details about a specified node pool.

Go debug

Updating a Specified Node Pool

hcloud CCE UpdateNodePool

This API is used to update a specified node pool. This API can be called only when the cluster is in the available, scale-out, or scale-in state.

Go debug

Deleting a Node Pool

hcloud CCE DeleteNodePool

This API is used to delete a specified node pool.

Go debug

Node Pool Upgrade

hcloud CCE UpgradeNodePool

This API is used to synchronize the configurations of existing nodes in a node pool.

Go debug

Scaling a Node Pool

hcloud CCE ScaleNodePool

This API is used to scale in or out a node pool.

Go debug

Listing Add-on Instances

hcloud CCE ListAddonInstances

This API is used to list all add-on instances in the cluster.

Go debug

Installing an Add-on Instance

hcloud CCE CreateAddonInstance

This API is used to install an add-on instance by using an add-on template.

Go debug

Listing Add-on Templates

hcloud CCE ListAddonTemplates

This API is used to query add-on templates.

Go debug

Querying an Add-on Instance

hcloud CCE ShowAddonInstance

This API is used to obtain details about an add-on instance.

Go debug

Updating an Add-on Instance

hcloud CCE UpdateAddonInstance

This API is used to update an add-on instance.

Go debug

Deleting an Add-on Instance

hcloud CCE DeleteAddonInstance

This API is used to delete an add-on instance.

Go debug

Rolling Back an Add-on Instance

hcloud CCE RollbackAddonInstance

Roll back the add-on instance version to the source version. Only when the status.isRollbackable parameter is set to true, and the add-on instance is in the running, available, abnormal, upgradeFailed, or rollbackFailed state, the version can be rolled back to the source version.

Go debug

Creating Add-on Check Tasks in Batches

hcloud CCE BatchCreateAddonPrecheck

This API is used to create add-on check tasks in batches in a specified cluster.

Go debug

Obtaining the Add-on Check Task Results

hcloud CCE ListAddonPrecheckTasks

This API is used to obtain the results of the add-on check tasks in a cluster.

Go debug

Cluster upgrade

hcloud CCE UpgradeCluster

Cluster upgrade

Go debug

Obtaining Cluster Upgrade Task Details

hcloud CCE ShowUpgradeClusterTask

Upgrade task ID, obtained from the uid field in the response body after the cluster upgrade API is called.

Go debug

Retrying a Cluster Upgrade Task

hcloud CCE RetryUpgradeClusterTask

Execute the failed cluster upgrade task again.

Go debug

Suspending a Cluster Upgrade Task

hcloud CCE PauseUpgradeClusterTask

Suspend the cluster upgrade task.

Go debug

Continue to execute the cluster upgrade task.

hcloud CCE ContinueUpgradeClusterTask

Resume the suspended cluster upgrade task.

Go debug

Enabling the Cluster Upgrade Process Booting Task

hcloud CCE CreateUpgradeWorkFlow

This API is used to create a cluster upgrade booting task. After the booting task is created by calling this API, start the check through the cluster pre-upgrade check.

Go debug

Obtaining a List of Upgrade Workflows

hcloud CCE ListUpgradeWorkFlows

Obtain a list of historical cluster upgrade booting tasks.

Go debug

Backing Up a Cluster

hcloud CCE CreateClusterMasterSnapshot

Cluster backup

Go debug

Obtaining a List of Cluster Upgrade Task Details

hcloud CCE ListUpgradeClusterTasks

Obtain a list of cluster upgrade task details.

Go debug

Performing a Pre-upgrade Check

hcloud CCE CreatePreCheck

Pre-upgrade check

Go debug

Obtaining Details About a Pre-upgrade Check Task of a Cluster

hcloud CCE ShowPreCheck

Obtain details about a pre-upgrade check task of a cluster. The task ID is obtained from the uid field in the response body after the cluster check API is called.

Go debug

Obtaining a List of Pre-upgrade Check Tasks of a Cluster

hcloud CCE ListPreCheckTasks

Obtain a list of pre-upgrade check tasks of a cluster.

Go debug

Obtaining the Cluster Upgrade Information

hcloud CCE ShowClusterUpgradeInfo

Obtain the cluster upgrade information.

Go debug

Obtaining a List of Cluster Backup Task Details

hcloud CCE ListClusterMasterSnapshotTasks

Obtain a list of cluster backup task details.

Go debug

Obtaining Details About a Specified Cluster Upgrade Task

hcloud CCE ShowUpgradeWorkFlow

This API is used to obtain details about an upgrade booting task based on the task ID.

Go debug

Updating the Status of a Specified Cluster Upgrade Booting Task

hcloud CCE UpgradeWorkFlowUpdate

This API is used to update the status of a specified cluster upgrade booting task. This API applies only to the upgrade cancellation process.

Go debug

Obtaining the Configuration of Cluster Upgrade Feature Gates

hcloud CCE ListClusterUpgradeFeatureGates

Obtain the configuration of cluster upgrade feature gates.

Go debug

Performing a Post-upgrade Check

hcloud CCE CreatePostCheck

Post-upgrade check, which is used by the customer to check the cluster status after an upgrade and provide feedback after services are restored. Use this API with the console.

Go debug

Obtaining a Cluster Upgrade Path

hcloud CCE ListClusterUpgradePaths

Obtain the cluster upgrade path.

Go debug

Querying Resource Quotas

hcloud CCE ShowQuotas

This API is used to query CCE resource quotas.

Go debug

Listing API Versions

hcloud CCE ShowVersion

This API is used to query the list of API versions supported by CCE.

Go debug

Adding Resource Tags to a Specified Cluster in Batches

hcloud CCE BatchCreateClusterTags

This API is used to add resource tags for a specified cluster in batches.

Go debug

Deleting Resource Tags of a Specified Cluster in Batches

hcloud CCE BatchDeleteClusterTags

This API is used to delete resource tags of a specified cluster in batches.

Go debug

Obtaining Resource Tags

hcloud CCE GetResourceTags

This API is used to obtain resource tags.

Go debug

Obtaining Custom Tags

hcloud CCE GetCustomizeTags

This API is used to obtain custom tags.

Go debug

Obtaining Node Labels

hcloud CCE GetLabels

This API is used to obtain the labels of all nodes in a cluster.

Go debug

Obtaining the Parameters That Can Be Configured for a Node Pool

hcloud CCE ShowNodePoolConfigurations

This API is used to obtain the parameters that can be configured for a node pool.

Go debug

Changing the Values of Configuration Parameters of a Node Pool

hcloud CCE UpdateNodePoolConfiguration

This API is used to change the values of parameter configurations of a node pool in the CCE cluster.

Go debug

Obtaining the Parameters That Can Be Configured for a Node Pool

hcloud CCE ShowNodePoolConfigurationDetails

This API is used to obtain the parameters that can be configured in a specified CCE node pool.

Go debug

Obtaining the List of Configurable Parameters Supported by a Cluster

hcloud CCE ShowClusterSupportConfiguration

This API is used to obtain the detailed configuration items supported by a cluster based on factors like the cluster version or type. It is specified during cluster creation.

Go debug

Obtaining the List of Parameters That Can Be Configured for a Cluster

hcloud CCE ShowClusterConfigurationDetails

This API is used to obtain the list of parameters that can be configured for a CCE cluster.

Go debug

Obtaining a Chart List

hcloud CCE ListCharts

This API is used to obtain the chart list.

Go debug

Uploading a Chart

hcloud CCE UploadChart

This API is used to upload a chart.

Go debug

Obtaining a Chart

hcloud CCE ShowChart

This API is used to obtain a chart.

Go debug

Updating a Chart

hcloud CCE UpdateChart

This API is used to update a chart.

Go debug

Deleting a Chart

hcloud CCE DeleteChart

This API is used to delete a chart.

Go debug

Downloading a Chart

hcloud CCE DownloadChart

This API is used to download a chart.

Go debug

Obtaining Chart Values

hcloud CCE ShowChartValues

This API is used to obtain chart values.

Go debug

Obtaining the Quota of a User Chart

hcloud CCE ShowUserChartsQuotas

This API is used to obtain the quota of a user chart.

Go debug

Obtaining a Release List

hcloud CCE ListReleases

This API is used to obtain a release list.

Go debug

Creating a Release

hcloud CCE CreateRelease

This API is used to create a release.

Go debug

Obtaining a Release

hcloud CCE ShowRelease

This API is used to obtain a release.

Go debug

Updating a Release

hcloud CCE UpdateRelease

This API is used to update a release.

Go debug

Deleting a Release

hcloud CCE DeleteRelease

This API is used to delete a release.

Go debug

Obtaining Historical Records of a Release

hcloud CCE ShowReleaseHistory

This API is used to obtain historical records of a release.

Go debug

Creating an Access Policy

hcloud CCE CreateAccessPolicy

This API is used to create an access policy.

Go debug

Obtaining the Access Policy List

hcloud CCE ListAccessPolicy

This API is used to obtain the access policy list.

Go debug

Obtaining Access Policy Details

hcloud CCE GetAccessPolicy

This API is used to obtain an access policy.

Go debug

Updating an Access Policy

hcloud CCE UpdateAccessPolicy

This API is used to update an access policy.

Go debug

Deleting an Access Policy

hcloud CCE DeleteAccessPolicy

This API is used to delete an access policy.

Go debug

Create pod-identity association

hcloud CCE CreatePodIdentityAssociation

This API is used to create pod-identity association, in which service account in certain cluster is bound to agency

Go debug

Obtaining the pod-identity association list in certain cluster

hcloud CCE ListPodIdentityAssociations

The API is used to obtain the pod-identity association list in certain cluster

Go debug

Obtaining pod-identity association detail

hcloud CCE ShowPodIdentityAssociation

The API is used to obtain pod-identity association detail

Go debug

Update pod-identity association

hcloud CCE UpdatePodIdentityAssociation

The API is used to update agency attribute of a pod-identity association

Go debug

Delete pod-identity association

hcloud CCE DeletePodIdentityAssociation

The API is used to delete a pod-identity association

Go debug

Assume for temporary credentials of pod-identity association

hcloud CCE AssumeAgencyForPodIdentity

The API is used to assume for temporary credentials of pod-identity association

Go debug