CLI Command Reference

Creating an Image Cache

hcloud CCE CreateImageCache

This API is used to create an image cache. During the creation, a temporary pod is started for the image cache in the specified cluster. After the image cache is created, you can use it to greatly reduce the time required for downloading the container images during workload creation and quickly start the containers. A tenant can create a maximum of 50 image caches.

Go debug

Listing Image Caches

hcloud CCE ListImageCaches

Listing Image Caches

Go debug

Viewing Details About an Image Cache

hcloud CCE ShowImageCache

This API is used to view the details about an image cache.

Go debug

Deleting an Image Cache

hcloud CCE DeleteImageCache

This API is used to delete an image cache.

Go debug

Obtaining Clusters in a Project

hcloud CCE ListAutopilotClusters

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

Go debug

Creating a Cluster

hcloud CCE CreateAutopilotCluster

This API is used to create an empty cluster, which has only master nodes but no worker nodes.

Go debug

Obtaining a Cluster

hcloud CCE ShowAutopilotCluster

This API is used to obtain details about a cluster.

Go debug

Updating a Cluster

hcloud CCE UpdateAutopilotCluster

This API is used to update a cluster.

Go debug

Deleting a Cluster

hcloud CCE DeleteAutopilotCluster

This API is used to delete a cluster.

Go debug

Obtaining a Cluster Certificate

hcloud CCE CreateAutopilotKubernetesClusterCert

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

Go debug

Obtaining Job Information

hcloud CCE ShowAutopilotJob

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 UpdateAutopilotClusterEip

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 ShowAutopilotClusterEndpoints

This API is used to obtain the cluster access addresses by cluster ID, including the private IP and public IP.

Go debug

Obtaining Cluster Log Configurations

hcloud CCE ShowAutopilotClusterConfig

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

Go debug

Obtaining the Feature Gate Status

hcloud CCE ShowAutopilotFeatureGates

This API is used to obtain the feature gate status.

Go debug

Listing Add-on Instances

hcloud CCE ListAutopilotAddonInstances

This API is used to obtain all add-on instances in a cluster.

Go debug

Creating an Add-on Instance

hcloud CCE CreateAutopilotAddonInstance

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

Go debug

Listing Add-on Templates

hcloud CCE ListAutopilotAddonTemplates

This API is used to obtain an add-on template.

Go debug

Obtaining an Add-on Instance

hcloud CCE ShowAutopilotAddonInstance

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

Go debug

Updating an Add-on Instance

hcloud CCE UpdateAutopilotAddonInstance

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

Go debug

Deleting an Add-on Instance

hcloud CCE DeleteAutopilotAddonInstance

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

Go debug

Rolling Back an Add-on Instance

hcloud CCE RollbackAutopilotAddonInstance

This API is used to roll back the version of an add-on instance to the source version. Only when status.isRollbackable 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

Upgrading a Cluster

hcloud CCE UpgradeAutopilotCluster

This API is used to upgrade a cluster.

Go debug

Obtaining Cluster Upgrade Task Details

hcloud CCE ShowAutopilotUpgradeClusterTask

This API is used to obtain details about an upgrade task of a cluster. The task ID is 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 RetryAutopilotUpgradeClusterTask

This API is used to execute the failed cluster upgrade task again.

Go debug

Obtaining a List of Cluster Upgrade Task Details

hcloud CCE ListAutopilotUpgradeClusterTasks

This API is used to obtain a list of cluster upgrade task details.

Go debug

Performing a Pre-upgrade Check for a Cluster

hcloud CCE CreateAutopilotPreCheck

This API is used to perform a pre-upgrade check for a cluster.

Go debug

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

hcloud CCE ShowAutopilotPreCheck

This API is used to 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 ListAutopilotPreCheckTasks

This API is used to obtain a list of pre-upgrade check tasks of a cluster.

Go debug

Performing a Post-upgrade Check for a Cluster

hcloud CCE CreateAutopilotPostCheck

This API is used to perform a post-upgrade check for a cluster, 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

Backing Up a Cluster

hcloud CCE CreateAutopilotClusterMasterSnapshot

This API is used to back up a cluster.

Go debug

Obtaining a List of Cluster Backup Task Details

hcloud CCE ListAutopilotClusterMasterSnapshotTasks

This API is used to obtain a list of cluster backup task details.

Go debug

Obtaining the Cluster Upgrade Information

hcloud CCE ShowAutopilotClusterUpgradeInfo

This API is used to obtain the cluster upgrade information.

Go debug

Obtaining a Cluster Upgrade Path

hcloud CCE ListAutopilotClusterUpgradePaths

This API is used to obtain the cluster upgrade path.

Go debug

Obtaining the Configuration of Cluster Upgrade Feature Gates

hcloud CCE ListAutopilotClusterUpgradeFeatureGates

This API is used to obtain the configuration of cluster upgrade feature gates.

Go debug

Enabling the Cluster Upgrade Process Booting Task

hcloud CCE CreateAutopilotUpgradeWorkFlow

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 ListAutopilotUpgradeWorkFlows

This API is used to obtain a list of historical cluster upgrade booting tasks.

Go debug

Obtaining Details About a Specified Cluster Upgrade Booting Task

hcloud CCE ShowAutopilotUpgradeWorkFlow

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 UpgradeAutopilotWorkFlowUpdate

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 an Automatic Upgrade Plan

hcloud CCE ListAutopilotUpgradePlans

This API is used to obtain an automatic cluster upgrade plan.

Go debug

Postponing an Automatic Upgrade Plan

hcloud CCE UpdateAutopilotUpgradePlan

This API is used to postpone an automatic cluster upgrade plan.

Go debug

Obtaining CCE Resource Quotas

hcloud CCE ShowAutopilotQuotas

This API is used to get CCE resource quotas.

Go debug

Adding Resource Tags to a Cluster in Batches

hcloud CCE BatchCreateAutopilotClusterTags

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

Go debug

Deleting Resource Tags from a Cluster in Batches

hcloud CCE BatchDeleteAutopilotClusterTags

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

Go debug

Obtaining a Chart List

hcloud CCE ListAutopilotCharts

This API is used to obtain a chart list.

Go debug

Uploading a Chart

hcloud CCE UploadAutopilotChart

This API is used to upload a chart.

Go debug

Obtaining a Release List

hcloud CCE ListAutopilotReleases

This API is used to obtain a release list.

Go debug

Creating a Release

hcloud CCE CreateAutopilotRelease

This API is used to create a release.

Go debug

Obtaining a Chart

hcloud CCE ShowAutopilotChart

This API is used to obtain a chart.

Go debug

Updating a Chart

hcloud CCE UpdateAutopilotChart

This API is used to update a chart.

Go debug

Deleting a Chart

hcloud CCE DeleteAutopilotChart

This API is used to delete a chart.

Go debug

Obtaining a Release

hcloud CCE ShowAutopilotRelease

This API is used to obtain a release.

Go debug

Updating a Release

hcloud CCE UpdateAutopilotRelease

This API is used to update a release.

Go debug

Deleting a Release

hcloud CCE DeleteAutopilotRelease

This API is used to delete a release.

Go debug

Downloading a Chart

hcloud CCE DownloadAutopilotChart

This API is used to download a chart.

Go debug

Obtaining Chart Values

hcloud CCE ShowAutopilotChartValues

This API is used to obtain chart values.

Go debug

Obtaining Historical Records of a Release

hcloud CCE ShowAutopilotReleaseHistory

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

Go debug

Obtaining the Quota of a User Chart

hcloud CCE ShowAutopilotUserChartsQuotas

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

Go debug

Listing Jobs

hcloud CCE ListAutopilotJobs

This API is used to obtain all jobs in a specified project.

Go debug

Querying a Job

hcloud CCE GetAutopilotOneJob

This API is used to query the details of a job in a specified project.

Go debug

Deleting a Job

hcloud CCE DeleteAutopilotJob

This API is used to delete a job in a specified project.

Go debug