CLI Command Reference

Querying the Cluster List

hcloud UCS ShowClusterList

This API is used to query the cluster list.

Go debug

Registering a Cluster

hcloud UCS RegisterCluster

This API is used to register a cluster. Third-party clusters and CCE clusters can be registered.

Go debug

Querying a Cluster

hcloud UCS ShowCluster

This API is used to query a cluster. The cluster ID must comply with the Kubernetes UUID format rules, and you must have the required permission on the corresponding cluster. Otherwise, the authentication fails.

Go debug

Updating a Cluster

hcloud UCS UpdateCluster

This API is used to update a cluster. Currently, only the country/city of attached clusters and on-premises clusters, and the number of worker nodes in a multi-cloud cluster can be updated.

Go debug

Deregistering a Cluster

hcloud UCS DeleteCluster

This API is used to deregister a cluster. The cluster ID must comply with the Kubernetes UUID format rules, and you must have the required permission on the corresponding cluster. Otherwise, the authentication fails.

Go debug

Querying Cluster Access Information

hcloud UCS ShowClusterAccessInfo

This API is used to query the cluster access information. The cluster ID must comply with the Kubernetes UUID format rules, and you must have the permission to query the corresponding cluster. Otherwise, the authentication fails. The agent certificate can be downloaded only once. This API is only used to query the access information of third-party clusters. If a CCE cluster ID is transferred, 400 will be returned.

Go debug

Activating a Cluster

hcloud UCS RetryClusterActivation

This API is used to activate a cluster. The cluster ID must comply with the Kubernetes UUID format rules, and you must have the required permission on the corresponding cluster. Otherwise, the authentication fails.

Go debug

Querying the CCE Cluster List

hcloud UCS ListManagedClusters

This API is used to query CCE cluster list.

Go debug

Associating a Cluster with Permission Policies

hcloud UCS UpdateClusterRules

This API is used to associate a cluster with permission policies.

Go debug

Querying the Cluster Version List

hcloud UCS ListRegisteredClusterVersions

This API is used to query the list of cluster versions that are supported by UCS.

Go debug

Obtaining the Fleet List

hcloud UCS ListClusterGroup

This API is used to list all fleets.

Go debug

Registering a Fleet

hcloud UCS RegisterClusterGroup

This API is used to create a fleet. You can select clusters during fleet creation.

Go debug

Querying a Fleet

hcloud UCS ShowClusterGroup

This API is used to query a fleet.

Go debug

Deleting a Fleet

hcloud UCS DeleteClusterGroup

This API is used to delete a fleet. A fleet can only be deleted when there are no clusters in it. To delete a fleet, remove the clusters from the fleet first. The cluster IDs must comply with the Kubernetes UUID format rules, and you must have the operation permission on the clusters. Otherwise, the authentication fails.

Go debug

Adding Clusters to a Fleet

hcloud UCS UpdateClusterGroupAssociatedClusters

This API is used to add clusters to a fleet. One or more clusters can be added at the same time. This API cannot be used to remove clusters from a fleet.

Go debug

Updating Permission Policies Associated with a Fleet

hcloud UCS UpdateClusterGroupAssociatedRules

This API is used to update the permission policies associated with a fleet.

Go debug

Updating Fleet Description

hcloud UCS UpdateClusterGroup

This API is used to update the description of a fleet. You must have the permission to update the fleet.

Go debug

Adding a Cluster to a Fleet

hcloud UCS JoinGroup

This API is used to add a cluster to a fleet.

Go debug

Removing a Cluster from a Fleet

hcloud UCS LeaveGroup

This API is used to remove a cluster from a fleet.

Go debug

Querying Federation Enabling Progress

hcloud UCS ShowFederationProgress

This API is used to query the federation enabling progress.

Go debug

Enabling Fleet Federation

hcloud UCS EnableFederation

Enabling Fleet Federation

Go debug

Disabling Cluster Federation

hcloud UCS DisableFederation

This API is used to disable cluster federation for a fleet.

Go debug

Updating the Zone Associated with the Federation of a Fleet

hcloud UCS UpdateClusterGroupAssociatedZones

This API is used to update the zone associated with the federation of a fleet.

Go debug

Creating a Federation Connection and Downloading kubeconfig

hcloud UCS CreateFederationCert

This API is used to create a VPC endpoint for connecting to the federation API server and downloading kubeconfig of the federation API server after federation is enabled for a fleet.

Go debug

Creating a Federation Connection

hcloud UCS CreateFederationConnection

This API is used to create a VPC endpoint for connecting to the federation API server after federation is enabled for a fleet.

Go debug

Downloading Federation kubeconfig

hcloud UCS DownloadFederationKubeconfig

This API is used to download the kubeconfig file after the federation is enabled for a fleet and the federation connection is created.

Go debug

Querying the Permission Policy List

hcloud UCS ListRule

This API is used to query the permission policy list.

Go debug

Creating a Permission Policy

hcloud UCS CreateRule

This API is used to create a permission policy.

Go debug

Updating a Permission Policy

hcloud UCS UpdateRule

Updating a permission policy

Go debug

Deleting a Permission Policy

hcloud UCS DeleteRule

This API is used to delete a permission policy.

Go debug

Obtaining an Add-on Instance

hcloud UCS ShowAddonInstance

This API is used to obtain the add-on instance.

Go debug

Updating an Add-on Instance

hcloud UCS UpdateAddonInstance

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

Go debug

Uninstalling an Add-on Instance

hcloud UCS DeleteAddonInstance

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

Go debug

Obtaining the Add-on Instance List

hcloud UCS ListAddonInstances

This API is used to obtain the add-on instance list.

Go debug

Installing an Add-on Instance

hcloud UCS CreateAddonInstance

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

Go debug

Obtaining the Add-on Template List

hcloud UCS ListAddonTemplates

This API is used to obtain the add-on template list.

Go debug

Obtaining Information About All Configuration Sets

hcloud UCS ListConfigSets

This API is used to obtain information about all configuration sets.

Go debug

Creating a Configuration Set

hcloud UCS CreateConfigSet

This API is used to create a configuration set.

Go debug

Obtaining Details About a Configuration Set

hcloud UCS ShowConfigSet

This API is used to obtain details about a configuration set, including the repository source information.

Go debug

Updating a Configuration Set

hcloud UCS UpdateConfigSet

This API is used to update a configuration set, excluding the repository source.

Go debug

Deleting a Configuration Set

hcloud UCS DeleteConfigSet

This API is used to delete a configuration set, not the repository source.

Go debug

Collecting Statistics on the Statuses of All Configuration Sets of a User

hcloud UCS ShowGitopsStatistics

This API is used to collect statistics on the statuses of all configuration sets of a user.

Go debug

Obtaining the Repository Source List

hcloud UCS ListRepos

This API is used to obtain the repository source list.

Go debug

Creating a Repository Source

hcloud UCS CreateRepo

This API is used to create a repository source.

Go debug

Updating a Repository Source

hcloud UCS UpdateRepo

This API is used to update a repository source.

Go debug

Deleting a Repository Source

hcloud UCS DeleteRepo

This API is used to delete a repository source.

Go debug

Querying Service Configuration

hcloud UCS ListServerConfigs

This API is used to obtain the global configuration of each cluster type.

Go debug

Obtaining the Policy Instance List

hcloud UCS ListPolicyInstances

This API is used to obtain the policy instance list.

Go debug

Obtaining the Policy Definition List

hcloud UCS ListPolicyDefinitions

This API is used to obtain the policy definition list.

Go debug

Obtaining a Policy Definition

hcloud UCS ShowPolicyDefinition

This API is used to obtain a policy definition.

Go debug

Updating a Policy Definition

hcloud UCS UpdatePolicyDefination

This API is used to update a policy definition.

Go debug

Obtaining a Specific Policy Instance

hcloud UCS ShowPolicyInstance

This API is used to obtain a specific policy instance.

Go debug

Updating a Specific Policy Instance

hcloud UCS UpdatePolicyInstance

This API is used to update a specific policy instance.

Go debug

Deleting a Specific Policy Instance

hcloud UCS DeletePolicyInstance

This API is used to delete a specific policy instance.

Go debug

Obtaining the Policy Instance Job List

hcloud UCS ListPolicyJobs

This API is used to obtain the policy instance job list.

Go debug

Obtaining the Job Related to a Specific Policy Instance

hcloud UCS ShowPolicyJob

This API is used to obtain the job related to a specific policy instance.

Go debug

Querying the Record Set List

hcloud UCS ListRecordSets

This API is used to query the record set list.

Go debug

Creating a Record Set

hcloud UCS CreateRecordSet

This API is used to create a record set.

Go debug

Obtaining Quota Information

hcloud UCS ShowQuota

This API is used to obtain UCS quota information.

Go debug

Enabling the Policy Center for a Cluster

hcloud UCS EnableClusterPolicy

This API is used to enable the policy center for a cluster.

Go debug

Disabling the Policy Center of a Cluster

hcloud UCS DisableClusterPolicy

This API is used to disable the policy center of a cluster.

Go debug

Obtaining the Progress of Enabling GitOps

hcloud UCS ShowGitOpsStatus

This API is used to obtain the progress of enabling GitOps.

Go debug

Enabling the GitOps Add-on

hcloud UCS EnableGitOps

This API is used to enable the GitOps add-on.

Go debug

Uninstalling the GitOps add-on from a Cluster

hcloud UCS DisableGitOps

This API is used to uninstall the GitOps add-on from a cluster.

Go debug

Creating a Cluster Policy Instance

hcloud UCS CreateClusterPolicyInstance

This API is used to create a cluster policy instance.

Go debug

Obtaining the Configuration Required for Cluster Installation

hcloud UCS CreateClusterConf

This API is used to obtain the configuration required for cluster installation (currently, only for on-premises clusters).

Go debug

Obtaining the kubeconfig of a Cluster

hcloud UCS CreateClusterKubeconfig

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

Go debug

Querying a Federated Workload

hcloud UCS ShowProxyUnitedWorkload

This API is used to query a federated workload.

Go debug

Creating a Federated Workload

hcloud UCS CreateProxyUnitedWorkload

This API is used to create a federated workload.

Go debug

Updating a Federated Workload

hcloud UCS UpdateProxyUnitedWorkload

This API is used to update a federated workload.

Go debug

Deleting a Federated Workload

hcloud UCS DeleteProxyUnitedWorkload

This API is used to delete a federated workload.

Go debug

Enabling the Policy Center for a Fleet

hcloud UCS EnableClusterGroupPolicy

This API is used to enable the policy center for a fleet.

Go debug

Disabling the Policy Center of a Fleet

hcloud UCS DisableClusterGroupPolicy

This API is used to disable the policy center of a fleet.

Go debug

Creating a Fleet Policy Instance

hcloud UCS CreateClusterGroupPolicyInstance

This API is used to create a fleet policy instance.

Go debug

Upgrading the Federation

hcloud UCS UpgradeFederation

This API is used to upgrade the federation version.

Go debug