# API概览 UCS所提供的接口分为UCS接口与Karmada接口。通过配合使用UCS接口与Karmada接口，您可以完整的使用UCS的所有功能，包括注册集群、创建容器舰队等。 | 类型 | 子类型 | 说明 | |:---|:---|:---| | UCS接口 | [UCS集群] | 集群管理接口，包括注册、更新、删除集群的接口等。 通过这些接口，您可以注册集群、获取已注册集群的信息。 | | UCS接口 | [容器舰队] | 容器舰队管理接口，包括注册、删除容器舰队的接口等。 通过这些接口，您可以注册容器舰队、获取已注册容器舰队的信息。 | | UCS接口 | [插件管理] | 插件管理接口，包括获取、安装、更新插件实例的接口等。 | | UCS接口 | [策略管理] | 策略管理接口，包括获取、更新、删除策略的接口等。 | | UCS接口 | [流量管理] | 流量管理接口，包括创建域名解析记录集、查询域名解析记录集列表的接口 | | UCS接口 | [配额管理] | 配额管理接口，支持获取UCS服务下资源配额信息。 | | Karmada接口 | - | Karmada接口，关于如何调用请参见[使用Karmada API](https://support.huaweicloud.com/api-ucs/ucs_api_0021.html)。 | #### UCS集群 表1UCS集群 | API | 说明 | |:---|:---| | [获取集群列表](https://support.huaweicloud.com/api-ucs/ShowClusterList.html) | 获取集群信息列表。 | | [集群启用策略中心](https://support.huaweicloud.com/api-ucs/EnableClusterPolicy.html) | 集群启用策略中心。 | | [获取单个集群](https://support.huaweicloud.com/api-ucs/ShowCluster.html) | 获取单个集群的信息。 | | [集群关闭策略中心](https://support.huaweicloud.com/api-ucs/DisableClusterPolicy.html) | 集群关闭策略中心。 | | [注册集群](https://support.huaweicloud.com/api-ucs/RegisterCluster.html) | 集群注册接口。支持附着集群的注册和CCE导入集群的注册。 | | [更新集群](https://support.huaweicloud.com/api-ucs/UpdateCluster.html) | 更新集群。当前仅允许更新附着集群和本地集群的国家/城市。 | | [获取集群安装时所需的配置信息](https://support.huaweicloud.com/api-ucs/CreateClusterConf.html) | 获取集群安装时所需的配置信息，当前仅本地集群使用。 | | [删除集群](https://support.huaweicloud.com/api-ucs/DeleteCluster.html) | 用于集群解除注册。 | | [获取集群接入信息](https://support.huaweicloud.com/api-ucs/ShowClusterAccessInfo.html) | 该API接口用于获取集群接入信息。 | | [创建集群策略实例](https://support.huaweicloud.com/api-ucs/CreateClusterPolicyInstance.html) | 创建集群策略实例。 | | [激活集群](https://support.huaweicloud.com/api-ucs/RetryClusterActivation.html) | 激活集群接口。 | | [获取集群kubeconfig](https://support.huaweicloud.com/api-ucs/CreateClusterKubeconfig.html) | 获取集群kubeconfig。 | | [获取租户的CCE集群列表](https://support.huaweicloud.com/api-ucs/ListManagedClusters.html) | 获取当前租户的CCE集群列表。 | | [获取各个类型集群的全局配置](https://support.huaweicloud.com/api-ucs/ListServerConfigs.html) | 获取各个类型集群的全局配置。 | | [查询支持接入UCS的集群版本列表](https://support.huaweicloud.com/api-ucs/ListRegisteredClusterVersions.html) | 查询支持接入UCS的集群版本列表。 | | [查询特性开关状态](https://support.huaweicloud.com/api-ucs/ListFeatureGates.html) | 查询特性开关状态。 | #### 容器舰队 表2容器舰队 | API | 说明 | |:---|:---| | [集群加入容器舰队](https://support.huaweicloud.com/api-ucs/JoinGroup.html) | 集群加入容器舰队。 | | [集群移出容器舰队](https://support.huaweicloud.com/api-ucs/LeaveGroup.html) | 集群移出容器舰队。 | | [注册容器舰队](https://support.huaweicloud.com/api-ucs/RegisterClusterGroup.html) | 容器舰队创建API，生成容器舰队时可以选择关联的集群。 | | [舰队启用策略中心](https://support.huaweicloud.com/api-ucs/EnableClusterGroupPolicy.html) | 舰队启用策略中心。 | | [舰队关闭策略中心](https://support.huaweicloud.com/api-ucs/DisableClusterGroupPolicy.html) | 舰队关闭策略中心。 | | [删除容器舰队](https://support.huaweicloud.com/api-ucs/DeleteClusterGroup.html) | 容器舰队删除接口，只有在容器舰队为空时才可以删除该容器舰队，若需删除请先将集群移出容器舰队。 | | [创建舰队策略实例](https://support.huaweicloud.com/api-ucs/CreateClusterGroupPolicyInstance.html) | 创建舰队策略实例。 | | [获取单个容器舰队](https://support.huaweicloud.com/api-ucs/ShowClusterGroup.html) | 获取单个容器舰队。 | | [向容器舰队中添加集群](https://support.huaweicloud.com/api-ucs/UpdateClusterGroupAssociatedClusters.html) | 向容器舰队中添加集群，同批次可以添加一个或多个集群，该接口无法清空或减少管理的集群。 | | [更新容器舰队描述信息](https://support.huaweicloud.com/api-ucs/UpdateClusterGroup.html) | 更新集群所属的容器舰队description信息，需要用户对相应容器舰队有更新权限。 | | [升级容器舰队联邦](https://support.huaweicloud.com/api-ucs/UpgradeFederation.html) | 容器舰队联邦版本升级。 | | [更新容器舰队的联邦对应的zone](https://support.huaweicloud.com/api-ucs/UpdateClusterGroupAssociatedZones.html) | 更新容器舰队的集群联邦关联的zone。 | | [获取容器舰队列表](https://support.huaweicloud.com/api-ucs/ListClusterGroup.html) | 获取所有容器舰队信息。 | | [启用容器舰队联邦](https://support.huaweicloud.com/api-ucs/EnableFederation.html) | 启用容器舰队联邦。 | | [关闭容器集群联邦](https://support.huaweicloud.com/api-ucs/DisableFederation.html) | 关闭容器舰队联邦 | | [查询联邦开启进度](https://support.huaweicloud.com/api-ucs/ShowFederationProgress.html) | 查询联邦开启进度 | | [创建联邦网络连接并下载联邦kubeconfig](https://support.huaweicloud.com/api-ucs/CreateFederationCert.html) | 舰队开通联邦后，调用此接口，创建vpcep终端节点，连接到联邦apiserver，并下载联邦apiserver的kubeconfig。 | | [创建联邦网络连接](https://support.huaweicloud.com/api-ucs/CreateFederationConnection.html) | 舰队开通联邦后，创建vpcep终端节点连接到联邦apiserver。 | | [下载联邦kubeconfig](https://support.huaweicloud.com/api-ucs/DownloadFederationKubeconfig.html) | 舰队开通联邦并且创建网络连接之后，可以使用此接口下载联邦的kubeconfig。 | | [查询联邦工作负载](https://support.huaweicloud.com/api-ucs/ShowProxyUnitedWorkload.html) | 查询联邦工作负载。 | | [创建联邦工作负载](https://support.huaweicloud.com/api-ucs/CreateProxyUnitedWorkload.html) | 创建联邦工作负载。 | | [删除联邦工作负载](https://support.huaweicloud.com/api-ucs/DeleteProxyUnitedWorkload.html) | 删除联邦工作负载。 | | [更新联邦工作负载](https://support.huaweicloud.com/api-ucs/UpdateProxyUnitedWorkload.html) | 更新联邦工作负载。 | | [联邦版本回滚](https://support.huaweicloud.com/api-ucs/RollbackFederation.html) | 联邦版本回滚。 | #### 插件管理 表3插件管理 | API | 说明 | |:---|:---| | [获取插件实例列表](https://support.huaweicloud.com/api-ucs/ListAddonInstances.html) | 获取插件实例列表。 | | [安装插件实例](https://support.huaweicloud.com/api-ucs/CreateAddonInstance.html) | 安装插件实例。 | | [更新插件实例](https://support.huaweicloud.com/api-ucs/UpdateAddonInstance.html) | 更新插件实例。 | | [获取插件实例](https://support.huaweicloud.com/api-ucs/ShowAddonInstance.html) | 获取插件实例。 | | [卸载插件实例](https://support.huaweicloud.com/api-ucs/DeleteAddonInstance.html) | 卸载插件实例。 | | [获取插件模板列表](https://support.huaweicloud.com/api-ucs/ListAddonTemplates.html) | 获取插件模板列表。 | | [获取单个插件模板](https://support.huaweicloud.com/api-ucs/ShowAddonTemplate.html) | 获取单个插件模板。 | #### 策略管理 表4策略管理 | API | 说明 | |:---|:---| | [获取策略定义列表](https://support.huaweicloud.com/api-ucs/ListPolicyDefinitions.html) | 获取策略定义列表。 | | [更新策略定义](https://support.huaweicloud.com/api-ucs/UpdatePolicyDefination.html) | 更新策略定义。 | | [获取策略定义](https://support.huaweicloud.com/api-ucs/ShowPolicyDefinition.html) | 获取策略定义。 | | [获取策略实例列表](https://support.huaweicloud.com/api-ucs/ListPolicyInstances.html) | 获取策略实例列表。 | | [删除指定策略实例](https://support.huaweicloud.com/api-ucs/DeletePolicyInstance.html) | 删除指定策略实例。 | | [获取指定策略实例](https://support.huaweicloud.com/api-ucs/ShowPolicyInstance.html) | 获取指定策略实例。 | | [更新指定策略实例](https://support.huaweicloud.com/api-ucs/UpdatePolicyInstance.html) | 更新指定策略实例。 | | [获取指定策略实例相关任务](https://support.huaweicloud.com/api-ucs/ShowPolicyJob.html) | 获取指定策略实例相关任务。 | | [获取策略实例任务列表](https://support.huaweicloud.com/api-ucs/ListPolicyJobs.html) | 获取策略实例任务列表。 | | [重试创建策略实例](https://support.huaweicloud.com/api-ucs/RetryPolicyInstanceCreate.html) | 重试创建策略实例。 | | [重试更新策略实例](https://support.huaweicloud.com/api-ucs/RetryPolicyInstanceUpdate.html) | 重试更新策略实例。 | | [重试删除策略实例](https://support.huaweicloud.com/api-ucs/RetryPolicyInstanceDelete.html) | 重试删除策略实例。 | #### 流量管理 表5流量管理 | API | 说明 | |:---|:---| | [创建域名解析记录集](https://support.huaweicloud.com/api-ucs/CreateRecordSet.html) | 创建域名解析记录集。 | | [查询域名解析记录集列表](https://support.huaweicloud.com/api-ucs/ListRecordSets.html) | 查询域名解析记录集列表。 | #### 配额管理 表6配额管理 | API | 说明 | |:---|:---| | [获取配额信息](https://support.huaweicloud.com/api-ucs/ShowQuota.html) | 获取UCS配额信息。 |