API概览

更新时间: 2023-10-19 14:58:48

容器服务Kubernetes版提供以下API接口。

重要

在使用API管理Kubernetes集群前,请确保您已阅读和同意阿里云容器服务Kubernetes版服务条款使用须知及高危风险操作说明

集群

API

描述

创建Kubernetes专有版集群

调用CreateCluster创建一个标准Kubernetes专有版集群。

创建Kubernetes托管版集群

调用CreateCluster创建一个新的Managed Kubernetes集群实例,并创建指定数量的节点。

创建ACK Serverless集群

调用CreateCluster创建一个新的ACK Serverless集群实例。

创建ACK Edge集群

调用CreateCluster创建一个新的ACK Edge集群实例。

创建专有版安全沙箱Kubernetes集群

调用CreateCluster创建一个专有版安全沙箱Kubernetes集群。

创建基础托管版安全沙箱Kubernetes集群

调用CreateCluster创建一个托管版安全沙箱Kubernetes集群。

查询所有集群列表

调用DescribeClustersV1查看您在ACK中创建的所有集群(包括Swarm和Kubernetes集群)。

查询集群实例

调用DescribeClusterDetail,根据集群ID,查看集群的详细信息。

查询集群资源

调用DescribeClusterResources查询指定集群的所有资源。

查询集群代理

调用DescribeExternalAgent查询额外代理。

查询集群日志

调用DescribeClusterLogs查询指定集群日志。

查询集群节点

调用DescribeClusterNodes查询集群节点。

查询任务详情

调用DescribeTaskInfo根据任务ID查询任务执行详情。

获取集群KubeConfig接口

调用DescribeClusterUserKubeconfig返回包含当前登录用户身份信息的Kubernetes集群访问kubeconfig。

查询Kubernetes版本详情

调用DescribeKubernetesVersionMetadata查询支持的Kubernetes版本的详细信息。

查询用户配额

调用DescribeUserQuota查询用户配额。

查询用户事件

调用DescribeEvents查询用户操作事件。

添加已有ENS节点至ACK边缘托管集群

调用AttachInstances接口添加已有ENS节点至ACK Edge集群

修改集群

调用ModifyCluster修改集群。

迁移集群

调用MigrateCluster将集群从标准托管版迁移至Pro托管版。

删除集群

调用DeleteCluster根据集群ID,删除集群实例,并释放集群所有节点资源。

创建自动伸缩配置

调用CreateAutoscalingConfig创建自动伸缩配置。

权限

API

描述

查询RAM用户或RAM角色集群授权信息

调用DescribeUserPermission查询指定RAM用户的集群授权信息。

全量更新RAM用户或RAM角色集群授权信息

调用GrantPermissions全量更新RAM用户集群授权信息。

更新用户KubeConfig证书默认过期时间

调用UpdateK8sClusterUserConfigExpire更新用户证书过期时间。

节点池

API

描述

创建节点池

调用CreateClusterNodePool为集群创建节点池。

扩缩容节点池

调用ModifyClusterNodePool扩缩容节点池节点。

修改节点池配置

调用ModifyClusterNodePool更新节点配置。

查询节点池列表

调用DescribeClusterNodePools查询集群内所有节点池详情。

查询节点池详情

调用DescribeClusterNodePoolDetail查询集群指定节点池详情。

添加已有实例至节点池

调用AttachInstances添加已有实例到集群。

手动添加已有实例至节点池

调用DescribeClusterAttachScripts添加已有节点到ACK Edge集群。该API返回唯一的可执行脚本,您获取脚本后,在已有节点上执行即可完成该节点的接入。

修复节点池节点

调用RepairClusterNodePool修复指定的托管节点池内指定节点存在的问题。

移除节点池节点

调用RemoveNodePoolNodes移除指定集群额外节点。

删除节点池

调用DeleteClusterNodepool删除节点池。

升级

API

描述

升级集群

调用UpgradeCluster升级指定用户集群。

查询集群升级状态

调用GetUpgradeStatus查询集群升级状态。

暂停集群升级

调用PauseClusterUpgrade暂停用户集群升级。

取消集群升级

调用CancelClusterUpgrade取消集群升级。

恢复集群升级

调用ResumeUpgradeCluster重新开始暂停集群的升级。

应用

API

描述

创建编排模板

调用CreateTemplate创建一个模板。

查询所有编排模板

调用DescribeTemplates查询编排模板。

查询编排模板详情

调用DescribeTemplateAttribute查看指定模板的详细信息。

更新编排模板

调用UpdateTemplate更新一个编排模板。

删除编排模板

调用DeleteTemplate删除指定模板。

创建触发器

调用CreateTrigger为应用创建触发器。

查询触发器

调用DescribeTrigger查询指定应用触发器。

删除触发器

调用DeleteTrigger删除应用触发器。

组件

API

描述

安装集群组件

调用InstallClusterAddons为指定集群安装组件。

查询集群组件详情

调用DescribeAddons查询集群安装的组件详情。

查询集群组件版本

调用DescribeClusterAddonsVersion查询指定集群的组件版本。

查询集群组件升级状态

调用DescribeClusterAddonsUpgradeStatus同时查询多个组件的升级状态。

查询集群组件版本元数据

调用DescribeClusterAddonMetadata查询特定集群可使用的指定组件版本信息,包括组件版本、可配置参数等。

修改集群组件配置

调用ModifyClusterAddon修改已安装的集群组件配置。

升级集群组件

调用UpgradeClusterAddons将指定组件升级到指定版本。

卸载集群组件

调用UnInstallClusterAddons卸载指定集群的组件。

标签

API

描述

绑定资源标签

调用TagResources为指定的集群绑定特定标签。

修改集群标签

调用ModifyClusterTags修改当前Kubernetes集群的标签。

查询资源标签列表

调用ListTagResources查询可见的资源标签关系。

解绑资源标签

调用UntagResources为指定的集群解绑标签。

策略治理

API

描述

在指定集群中部署策略规则实例

调用DeployPolicyInstance在指定集群中部署策略规则实例。

列举策略治理规则库列表

调用DescribePolicies列举策略治理规则库列表。

在指定集群中更新策略规则实例

调用ModifyPolicyInstance在指定集群中更新策略规则实例。

在指定集群中删除策略规则实例

调用DeletePolicyInstance在指定集群中删除策略规则实例。

获取策略治理规则模板详情

调用DescribePolicyDetails获取策略治理规则模板详情。

获取集群策略治理详情

调用DescribePolicyGovernanceInCluster获取集群策略治理详情。

获取集群中当前部署的策略实例

调用DescribePolicyInstances获取集群中当前部署的策略实例列表。

获取集群中策略规则实例详情

调用DescribePolicyInstancesStatus获取集群当前不同策略类型对应的实例部署状态,包括每种策略规则对应开启的实例计数,以及不同治理等级下开启的策略种类计数。

阿里云首页 容器服务 Kubernetes 版 ACK 相关技术圈