API概览
UCS所提供的接口分为UCS接口与Karmada接口。通过配合使用UCS接口与Karmada接口，您可以完整的使用UCS的所有功能，包括注册集群、创建容器舰队等。
| 类型 | 子类型 | 说明 |
|---|---|---|
| UCS接口 | 集群管理接口，包括注册、更新、删除集群的接口等。 通过这些接口，您可以注册集群、获取已注册集群的信息。 | |
| 容器舰队管理接口，包括注册、删除容器舰队的接口等。 通过这些接口，您可以注册容器舰队、获取已注册容器舰队的信息。 | ||
| 插件管理接口，包括获取、安装、更新插件实例的接口等。 | ||
| 策略管理接口，包括获取、更新、删除策略的接口等。 | ||
| 流量管理接口，包括创建域名解析记录集、查询域名解析记录集列表的接口 | ||
| 配额管理接口，支持获取UCS服务下资源配额信息。 | ||
| Karmada接口 | - | Karmada接口，关于如何调用请参见使用Karmada API。 |
UCS集群
| API | 说明 |
|---|---|
| 获取集群信息列表。 | |
| 集群启用策略中心。 | |
| 获取单个集群的信息。 | |
| 集群关闭策略中心。 | |
| 集群注册接口。支持附着集群的注册和CCE导入集群的注册。 | |
| 更新集群。当前仅允许更新附着集群和本地集群的国家/城市。 | |
| 获取集群安装时所需的配置信息，当前仅本地集群使用。 | |
| 用于集群解除注册。 | |
| 该API接口用于获取集群接入信息。 | |
| 创建集群策略实例。 | |
| 激活集群接口。 | |
| 获取集群kubeconfig。 | |
| 获取当前租户的CCE集群列表。 | |
| 获取各个类型集群的全局配置。 | |
| 查询支持接入UCS的集群版本列表。 | |
| 查询特性开关状态。 |
容器舰队
| API | 说明 |
|---|---|
| 集群加入容器舰队。 | |
| 集群移出容器舰队。 | |
| 容器舰队创建API，生成容器舰队时可以选择关联的集群。 | |
| 舰队启用策略中心。 | |
| 舰队关闭策略中心。 | |
| 容器舰队删除接口，只有在容器舰队为空时才可以删除该容器舰队，若需删除请先将集群移出容器舰队。 | |
| 创建舰队策略实例。 | |
| 获取单个容器舰队。 | |
| 向容器舰队中添加集群，同批次可以添加一个或多个集群，该接口无法清空或减少管理的集群。 | |
| 更新集群所属的容器舰队description信息，需要用户对相应容器舰队有更新权限。 | |
| 容器舰队联邦版本升级。 | |
| 更新容器舰队的集群联邦关联的zone。 | |
| 获取所有容器舰队信息。 | |
| 启用容器舰队联邦。 | |
| 关闭容器舰队联邦 | |
| 查询联邦开启进度 | |
| 舰队开通联邦后，调用此接口，创建vpcep终端节点，连接到联邦apiserver，并下载联邦apiserver的kubeconfig。 | |
| 舰队开通联邦后，创建vpcep终端节点连接到联邦apiserver。 | |
| 舰队开通联邦并且创建网络连接之后，可以使用此接口下载联邦的kubeconfig。 | |
| 查询联邦工作负载。 | |
| 创建联邦工作负载。 | |
| 删除联邦工作负载。 | |
| 更新联邦工作负载。 | |
| 联邦版本回滚。 |
