API Overview

UCS provides UCS APIs and Karmada APIs. By using UCS APIs and Karmada APIs together, you can use all functions provided by UCS, such as registering clusters and creating fleets.

Type	Subtype	Description
UCS APIs	UCS cluster APIs	APIs for managing clusters, such as registering, updating, and deleting clusters. You can use these APIs to register clusters and obtain information about registered clusters.
	Fleet APIs	APIs for managing fleets, such as creating and deleting fleets. You can use these APIs to create fleets and obtain information about created fleets.
	Add-on management APIs	APIs for managing add-ons, such as obtaining, installing, and updating add-on instances.
	Policy management APIs	APIs for managing policies, such as obtaining, updating, and deleting policies.
	Traffic management APIs	API for managing traffic, such as creating record sets and querying the record set list.
	Quota management APIs	APIs for obtaining UCS resource quotas
Karmada APIs	-	For details about how to call Karmada APIs, see Using Karmada APIs.

UCS Cluster APIs

**Table 1** UCS cluster APIs
API	Description
Obtaining the Cluster List	This API is used to obtain the cluster list.
Enabling the Policy Center for a Cluster	This API is used to enable the policy center for a cluster.
Obtaining a Cluster	This API is used to obtain information about a single cluster.
Disabling the Policy Center for a Cluster	This API is used to disable the policy center for a cluster.
Registering a Cluster	This API is used to register a cluster. Third-party clusters and CCE clusters can be registered.
Updating a Cluster	This API is used to update a cluster. Currently, only the country/city of attached clusters and on-premises clusters can be updated.
Obtaining the Configuration Required for Cluster Installation	This API is used to obtain the configuration required for cluster installation. Currently, this API is used only for on-premises clusters.
Deleting a Cluster	This API is used to deregister a cluster.
Obtaining Cluster Access Information	This API is used to obtain cluster access information.
Creating a Policy Instance for a Cluster	This API is used to create a policy instance for a cluster.
Activating a Cluster	This API is used to activate a cluster.
Obtaining the kubeconfig of a Cluster	This API is used to obtain the kubeconfig of a cluster.
Obtaining the CCE Cluster List of a Tenant	This API is used to obtain the CCE cluster list of the current tenant.
Obtaining the Global Configuration of Each Type of Clusters	This API is used to obtain the global configuration of each type of clusters.
Querying the Version List of Clusters That Can Be Connected to UCS	This API is used to query the version list of clusters that can be connected to UCS.
Obtaining the Feature Gate Status	This API is used to query the feature gate status.

Fleet APIs

**Table 2** Fleet APIs
API	Description
Adding a Cluster to a Fleet	This API is used to add a cluster to a fleet.
Removing a Cluster from a Fleet	This API is used to remove a cluster from a fleet.
Creating a Fleet	This API is used to create a fleet. You can select clusters during fleet creation.
Enabling the Policy Center for a Fleet	This API is used to enable the policy center for a fleet.
Disabling the Policy Center for a Fleet	This API is used to disable the policy center for a fleet.
Deleting a Fleet	This API is used to delete a fleet. A fleet can be deleted only when it is empty. To delete a fleet, remove all clusters from the fleet first.
Creating a Fleet Policy Instance	This API is used to create a fleet policy instance.
Obtaining a Fleet	This API is used to obtain a fleet.
Adding Clusters to a Fleet	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 all or some clusters from a fleet.
Updating Fleet Description	This API is used to update the description of a fleet. You must have the permissions to update the fleet.
Upgrading a Federation	This API is used to upgrade a federation.
Updating the Zone Associated with the Federation of a Fleet	This API is used to update the zone associated with the federation of a fleet.
Obtaining the Fleet List	This API is used to obtain the fleet list.
Enabling Cluster Federation	This API is used to enable cluster federation.
Disabling Cluster Federation	This API is used to disable cluster federation for a fleet.
Querying Federation Enabling Progress	This API is used to query the federation enabling progress.
Creating a Federation Connection and Downloading kubeconfig	This API is used to create a VPC endpoint for connecting to the federation API server and downloading kubeconfig from the federation API server after federation is enabled for a fleet.
Creating a Federation Connection	This API is used to create a VPC endpoint for connecting to the federation API server after federation is enabled for a fleet.
Downloading Federation kubeconfig	This API is used to download the kubeconfig after the cluster federation is enabled for a fleet and the federation connection is created.
Querying a Federated Workload	This API is used to query a federated workload.
Creating a Federated Workload	This API is used to create a federated workload.
Deleting a Federated Workload	This API is used to delete a federated workload.
Updating a Federated Workload	This API is used to update a federated workload.
Rolling Back the Federation Version	This API is used to roll back the federation version.

Add-on Management APIs

**Table 3** Add-on management APIs
API	Description
Obtaining the Add-on Instance List	This API is used to obtain the list of add-on instances.
Installing an Add-on Instance	This API is used to install an add-on instance.
Updating an Add-on Instance	This API is used to update an add-on instance.
Obtaining an Add-on Instance	This API is used to obtain an add-on instance.
Uninstalling an Add-on Instance	This API is used to uninstall an add-on instance.
Obtaining the Add-on Template List	This API is used to obtain the add-on template list.
Obtaining a Single Add-on Template	This API is used to obtain an add-on template.

Policy Management APIs

**Table 4** Policy management APIs
API	Description
Obtaining the Policy Definition List	This API is used to obtain the policy definition list.
Updating a Policy Definition	This API is used to update a policy definition.
Obtaining a Policy Definition	This API is used to obtain a policy definition.
Obtaining the Policy Instance List	This API is used to obtain the policy instance list.
Deleting a Policy Instance	This API is used to delete a specific policy instance.
Obtaining a Policy Instance	This API is used to obtain a specific policy instance.
Updating a Policy Instance	This API is used to update a specific policy instance.
Obtaining the Job Related to a Specific Policy Instance	This API is used to obtain the job related to a specific policy instance.
Obtaining the Policy Instance Job List	This API is used to obtain the list of jobs related to a specific policy instance.
Retrying to the Policy Instance Creation	This API is used to retry policy instance creation.
Retrying the Policy Instance Update	This API is used to retry the policy instance update.
Retrying the Policy Instance Deletion	This API is used to retry policy instance deletion.