CLI命令参考
集群管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 集群休眠 | hcloud CCE HibernateCluster | 集群休眠用于将运行中的集群置于休眠状态，休眠后，将不再收取控制节点资源费用。 | |
| 集群唤醒 | hcloud CCE AwakeCluster | 集群唤醒用于唤醒已休眠的集群，唤醒后，将继续收取控制节点资源费用。 | |
| 获取集群证书 | hcloud CCE CreateKubernetesClusterCert | 该API用于获取指定集群的证书信息。 | |
| 吊销用户的集群证书 | hcloud CCE RevokeKubernetesClusterCert | 该API用于吊销指定集群的用户证书 | |
| 轮转用户的集群证书 | hcloud CCE RotateClusterCredentials | 该API用于轮转指定集群的证书 | |
| 获取指定项目下的集群 | hcloud CCE ListClusters | 该API用于获取指定项目下所有集群的详细信息。 | |
| 创建集群 | hcloud CCE CreateCluster | 该API用于创建一个空集群（即只有控制节点，没有工作节点）。请在调用本接口完成集群创建之后，在集群中继续添加节点。 | |
| 获取指定的集群 | hcloud CCE ShowCluster | 该API用于获取指定集群的详细信息。 | |
| 更新指定的集群 | hcloud CCE UpdateCluster | 该API用于更新指定的集群。 | |
| 删除集群 | hcloud CCE DeleteCluster | 该API用于删除一个指定的集群。 | |
| 变更集群规格 | hcloud CCE ResizeCluster | 该API用于变更一个指定集群的规格。 | |
| 获取任务信息 | hcloud CCE ShowJob | 该API用于获取任务信息。通过某一任务请求下发后返回的jobID来查询指定任务的进度。 | |
| 绑定、解绑集群公网apiserver地址 | hcloud CCE UpdateClusterEip | 该API用于通过集群ID绑定、解绑集群公网apiserver地址 | |
| 获取集群访问的地址 | hcloud CCE ShowClusterEndpoints | 该API用于通过集群ID获取集群访问的地址，包括PrivateIP(HA集群返回VIP)与PublicIP | |
| 查询集群日志配置信息 | hcloud CCE ShowClusterConfig | 获取集群组件上报的LTS的配置信息 | |
| 配置集群日志 | hcloud CCE UpdateClusterLogConfig | 用户可以选择集群管理节点上哪些组件的日志上报LTS | |
| 获取分区列表 | hcloud CCE ListPartitions | 获取分区列表 | |
| 创建分区 | hcloud CCE CreatePartition | 创建分区 | |
| 获取分区详情 | hcloud CCE ShowPartition | 获取分区详情 | |
| 更新分区 | hcloud CCE UpdatePartition | 更新分区 | |
| 获取集群LongAKSK配置 | hcloud CCE GetClusterLongAkskConfig | 该API用于获取集群longaksk的配置。 | |
| 更新集群LongAKSK配置 | hcloud CCE UpdateClusterLongAkskConfig | 该API用于更新集群LongAKSK的配置。 | |
| 获取项目LongAKSK配置 | hcloud CCE GetLongAkskConfig | 该API用于获取项目LongAKSK的配置。 | |
| 更新项目LongAKSK配置 | hcloud CCE UpdateLongAkskConfig | 该API用于更新项目longaksk的配置。 | |
| 查询集群可售卖规格 | hcloud CCE GetClusterFlavorSpecs | 该API用于查询集群可售卖规格 | |
| 查询特性开关状态 | hcloud CCE ShowFeatureGates | 该API用于查询特性开关状态 | |
| 查询可用区列表 | hcloud CCE GetAvaliableZone | 该API用于查询可用区列表 | |
| 获取集群配额 | hcloud CCE GetClusterQuota | 该API用于获取集群配额 |
节点管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 获取集群下所有节点 | hcloud CCE ListNodes | 该API用于通过集群ID获取指定集群下所有节点的详细信息。 | |
| 创建节点 | hcloud CCE CreateNode | 该API用于在指定集群下创建节点。 | |
| 获取指定的节点 | hcloud CCE ShowNode | 该API用于通过节点ID获取指定节点的详细信息。 | |
| 更新指定的节点 | hcloud CCE UpdateNode | 该API用于更新指定的节点。 | |
| 删除节点 | hcloud CCE DeleteNode | 该API用于删除指定的节点。 | |
| 纳管节点 | hcloud CCE AddNode | 该API用于在指定集群下纳管节点。 | |
| 轮转节点证书 | hcloud CCE RotateNodeCert | 该API用于在指定集群下轮转节点证书。作为集群证书轮转操作的补偿机制：当通过配套的集群证书轮转接口执行轮转时，若部分节点证书轮转失败，可通过调用本接口进行重试。 | |
| 自定义节点池纳管节点 | hcloud CCE AddNodesToNodePool | 该API用于在指定集群自定义节点池下纳管节点。竞价实例不支持纳管。 | |
| 重置节点 | hcloud CCE ResetNode | 该API用于在指定集群下重置节点。 | |
| 节点移除 | hcloud CCE RemoveNode | 该API用于在指定集群下移除节点。 | |
| 节点开启缩容保护 | hcloud CCE LockNodepoolNodeScaleDown | 该API用于节点开启缩容保护，开启缩容保护的节点无法通过修改节点池个数的方式被缩容。 | |
| 节点关闭缩容保护 | hcloud CCE UnlockNodepoolNodeScaleDown | 该API用于节点关闭缩容保护，关闭缩容保护的节点可以通过修改节点池个数的方式被缩容，只允许按需节点关闭缩容保护。 | |
| 节点迁移 | hcloud CCE MigrateNode | 该API用于在指定集群下迁移节点到另一集群。 | |
| 节点迁移到自定义节点池。 | hcloud CCE MigrateToNodePool | 该API用于将节点迁移到自定义节点池，仅default节点池下节点支持迁移。迁移过程节点无重置无重启，原节点密码将保留。 | |
| 同步节点 | hcloud CCE SyncNode | 该API用于同步节点。 | |
| 批量同步节点 | hcloud CCE BatchSyncNodes | 该API用于批量同步节点。 | |
| 查询集群中超节点列表 | hcloud CCE ListHyperNodes | 该API用于获取指定集群下所有超节点的详细信息。 | |
| 按需节点转包年/包月 | hcloud CCE BatchChangeNodeToPeriod | 该API用于将节点从按需计费模式转成包周期计费模式。 |
节点池管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 获取集群下所有节点池 | hcloud CCE ListNodePools | 该API用于获取集群下所有节点池。 | |
| 创建节点池 | hcloud CCE CreateNodePool | 该API用于在指定集群下创建节点池。仅支持集群在处于可用、扩容、缩容状态时调用。 | |
| 获取指定的节点池 | hcloud CCE ShowNodePool | 该API用于获取指定节点池的详细信息。 | |
| 更新指定节点池 | hcloud CCE UpdateNodePool | 该API用于更新指定的节点池。仅支持集群在处于可用、扩容、缩容状态时调用。 | |
| 删除节点池 | hcloud CCE DeleteNodePool | 该API用于删除指定的节点池。 | |
| 同步节点池 | hcloud CCE UpgradeNodePool | 该API用于同步节点池中已有节点的配置 | |
| 伸缩节点池 | hcloud CCE ScaleNodePool | 该API用于伸缩指定的节点池 |
插件管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 获取AddonInstance列表 | hcloud CCE ListAddonInstances | 获取集群所有已安装插件实例 | |
| 创建AddonInstance | hcloud CCE CreateAddonInstance | 根据提供的插件模板，安装插件实例。 | |
| 查询AddonTemplates列表 | hcloud CCE ListAddonTemplates | 插件模板查询接口，查询插件信息。 | |
| 获取AddonInstance详情 | hcloud CCE ShowAddonInstance | 获取插件实例详情。 | |
| 更新AddonInstance | hcloud CCE UpdateAddonInstance | 更新插件实例的功能。 | |
| 删除AddonInstance | hcloud CCE DeleteAddonInstance | 删除插件实例的功能。 | |
| 回滚AddonInstance | hcloud CCE RollbackAddonInstance | 将插件实例回滚到升级前的版本。只有在当前插件实例版本支持回滚到升级前的版本（status.isRollbackable为true），且插件实例状态为running（运行中）、available（可用）、abnormal（不可用）、upgradeFailed（升级失败）、rollbackFailed（回滚失败）时支持回滚。 | |
| 批量创建插件检查任务 | hcloud CCE BatchCreateAddonPrecheck | 该API用于在指定集群下批量创建插件检查任务。 | |
| 获取插件检查任务结果列表 | hcloud CCE ListAddonPrecheckTasks | 获取集群下插件检查任务结果列表 |
集群升级
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 集群升级 | hcloud CCE UpgradeCluster | 集群升级。 | |
| 获取集群升级任务详情 | hcloud CCE ShowUpgradeClusterTask | 获取集群升级任务详情，任务ID由调用集群升级API后从响应体中uid字段获取。 | |
| 重试集群升级任务 | hcloud CCE RetryUpgradeClusterTask | 重新执行失败的集群升级任务。 | |
| 暂停集群升级任务 | hcloud CCE PauseUpgradeClusterTask | 暂停集群升级任务。 | |
| 继续执行集群升级任务 | hcloud CCE ContinueUpgradeClusterTask | 继续执行被暂停的集群升级任务。 | |
| 获取集群升级任务详情列表 | hcloud CCE ListUpgradeClusterTasks | 获取集群升级任务详情列表 | |
| 集群备份 | hcloud CCE CreateClusterMasterSnapshot | 集群备份 | |
| 获取集群备份任务详情列表 | hcloud CCE ListClusterMasterSnapshotTasks | 获取集群备份任务详情列表 | |
| 集群升级前检查 | hcloud CCE CreatePreCheck | 集群升级前检查 | |
| 获取集群升级前检查任务详情 | hcloud CCE ShowPreCheck | 获取集群升级前检查任务详情，任务ID由调用集群检查API后从响应体中uid字段获取。 | |
| 获取集群升级前检查任务详情列表 | hcloud CCE ListPreCheckTasks | 获取集群升级前检查任务详情列表 | |
| 集群升级后确认 | hcloud CCE CreatePostCheck | 集群升级后确认，该接口建议配合Console使用，主要用于升级步骤完成后，客户确认集群状态和业务正常后做反馈。 | |
| 获取集群升级相关信息 | hcloud CCE ShowClusterUpgradeInfo | 获取集群升级相关信息 | |
| 获取集群升级路径 | hcloud CCE ListClusterUpgradePaths | 获取集群升级路径 | |
| 获取集群升级特性开关配置 | hcloud CCE ListClusterUpgradeFeatureGates | 获取集群升级特性开关配置 | |
| 开启集群升级流程引导任务 | hcloud CCE CreateUpgradeWorkFlow | 该API用于创建一个集群升级流程引导任务。请在调用本接口完成引导任务创建之后，通过集群升级前检查开始检查任务。 | |
| 获取UpgradeWorkFlows列表 | hcloud CCE ListUpgradeWorkFlows | 获取历史集群升级引导任务列表 | |
| 获取指定集群升级引导任务详情 | hcloud CCE ShowUpgradeWorkFlow | 该API用于通过升级引导任务ID获取任务的详细信息。 | |
| 更新指定集群升级引导任务状态 | hcloud CCE UpgradeWorkFlowUpdate | 该API用于更新指定集群升级引导任务状态，当前仅适用于取消升级流程 |
配额管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询CCE服务下的资源配额 | hcloud CCE ShowQuotas | 该API用于查询CCE服务下的资源配额。 |
API版本信息
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询API版本信息列表 | hcloud CCE ShowVersion | 该API用于查询CCE服务当前支持的API版本信息列表。 |
标签管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 批量添加指定集群的资源标签 | hcloud CCE BatchCreateClusterTags | 该API用于批量添加指定集群的资源标签。 | |
| 批量删除指定集群的资源标签 | hcloud CCE BatchDeleteClusterTags | 该API用于批量删除指定集群的资源标签。 | |
| 查询资源标签 | hcloud CCE GetResourceTags | 该API用于查询资源标签 | |
| 查询自定义标签 | hcloud CCE GetCustomizeTags | 该API用于查询自定义标签 | |
| 获取节点标签 | hcloud CCE GetLabels | 该API用于获取集群所有节点的标签 |
配置管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询指定节点池支持配置的参数内容 | hcloud CCE ShowNodePoolConfigurations | 该API用于查询指定节点池支持配置的参数内容。 | |
| 修改指定节点池配置参数的值 | hcloud CCE UpdateNodePoolConfiguration | 该API用于修改CCE服务下指定节点池配置参数的值。 | |
| 查询指定节点池支持配置的参数列表 | hcloud CCE ShowNodePoolConfigurationDetails | 该API用于查询CCE服务下指定节点池支持配置的参数列表。 | |
| 查询指定集群支持配置的参数列表 | hcloud CCE ShowClusterConfigurationDetails | 该API用于查询CCE服务下指定集群支持配置的参数列表。 | |
| 获取集群支持的可配置参数列表 | hcloud CCE ShowClusterSupportConfiguration | 该API用于根据集群版本类型等查询集群支持的详细配置项，用于集群创建时指定。 |
模板管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 获取模板列表 | hcloud CCE ListCharts | 获取模板列表 | |
| 上传模板 | hcloud CCE UploadChart | 上传模板 | |
| 获取模板 | hcloud CCE ShowChart | 获取模板 | |
| 更新模板 | hcloud CCE UpdateChart | 更新模板 | |
| 删除模板 | hcloud CCE DeleteChart | 删除模板 | |
| 下载模板 | hcloud CCE DownloadChart | 下载模板 | |
| 获取模板Values | hcloud CCE ShowChartValues | 获取模板Values | |
| 获取用户模板配额 | hcloud CCE ShowUserChartsQuotas | 获取用户模板配额 | |
| 获取模板实例列表 | hcloud CCE ListReleases | 获取模板实例列表 | |
| 创建模板实例 | hcloud CCE CreateRelease | 创建模板实例 | |
| 获取指定模板实例 | hcloud CCE ShowRelease | 获取指定模板实例 | |
| 更新指定模板实例 | hcloud CCE UpdateRelease | 更新指定模板实例 | |
| 删除指定模板实例 | hcloud CCE DeleteRelease | 删除指定模板实例 | |
| 查询指定模板实例历史记录 | hcloud CCE ShowReleaseHistory | 查询指定模板实例历史记录 |
权限管理
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 创建访问策略 | hcloud CCE CreateAccessPolicy | 该API用于创建访问策略。 | |
| 获取访问策略列表 | hcloud CCE ListAccessPolicy | 该API用于获取访问策略列表。 | |
| 获取访问策略详情 | hcloud CCE GetAccessPolicy | 该API用于获取单个访问策略。 | |
| 更新访问策略 | hcloud CCE UpdateAccessPolicy | 该API用于更新单个访问策略。 | |
| 删除访问策略 | hcloud CCE DeleteAccessPolicy | 该API用于删除单个访问策略 | |
| 创建pod-identity关联 | hcloud CCE CreatePodIdentityAssociation | 该API用于创建pod-identity关联，将容器集群serviceaccount与IAM委托绑定。 | |
| 查询指定集群的pod-identity关联 | hcloud CCE ListPodIdentityAssociations | 该API用于获取集群下所有pod-identity关联。 | |
| 查询指定pod-identity关联 | hcloud CCE ShowPodIdentityAssociation | 该API用于查询指定pod-identity关联详情信息。 | |
| 更新pod-identity关联 | hcloud CCE UpdatePodIdentityAssociation | 该API用于更新指定pod-identity关联所绑定的IAM委托信息。 | |
| 删除pod-identity关联 | hcloud CCE DeletePodIdentityAssociation | 该API用于删除指定的pod-identity关联。 | |
| 获取pod-identity关联相关委托凭据 | hcloud CCE AssumeAgencyForPodIdentity | 该API用于通过ServiceAccount token来assume获取ServiceAccount所关联的pod-identity关联中绑定的IAM委托凭据。 |
