文档

API概览

更新时间:
本产品(容器服务Kubernetes版/2015-12-15)的OpenAPI采用ROA签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

API目录

API标题API概述
OpenAckService开通容器服务Kubernetes版首次使用容器服务Kubernetes版(Alibaba Cloud Container Service for Kubernetes,简称容器服务ACK)时,您需要使用阿里云账号(主账号)或有相应权限的RAM用户(子账号)开通并授权容器服务。

集群

API标题API概述
CreateCluster创建集群您可以通过OpenAPI创建ACK集群,包含ACK托管集群、ACK专有集群、ACK Serverless集群,ACK Edge集群以及注册集群。创建集群时,您将完成集群信息、集群组件以及ACK相关云资源的配置。
DeleteCluster删除集群如果您的集群无需使用,请删除集群并选择是否删除或保留集群的相关资源。删除集群前,请手动清理工作负载(无状态、有状态、任务和定时任务),否则可能导致集群删除失败。
DescribeClustersV1查询集群列表您可以调用DescribeClustersV1接口查看本账号下符合条件的ACK集群(例如指定集群类型、集群规格)列表信息。
DescribeClusterDetail查询指定集群的信息您可以调用DescribeClusterDetail接口,根据集群ID查询指定集群的详细信息。
DescribeClusterResources查询指定集群的关联资源您在使用容器服务 Kubernetes 版过程中,会同时使用其他关联的阿里云云产品资源。您可以调用DescribeClusterResources接口查询指定集群的关联资源,例如VPC、SLB等。如果您需要查询节点池或节点资源,您可以调用DescribeClusterNodePools或DescribeClusterNodes接口。
DescribeKubernetesVersionMetadata查询Kubernetes版本的详细详情您可以调用DescribeKubernetesVersionMetadata接口查询Kubernetes版本的详细信息,包括Kubernetes版本信息、版本的发布日期和过期时间、兼容的操作系统,使用的运行时等。
DescribeUserClusterNamespaces查询RAM用户或角色可见的集群命名空间在ACK集群中,可以通过Kubernetes命名空间对集群访问者进行权限和资源的逻辑隔离,只被授予指定命名空间下RBAC权限的用户将无法访问集群其他命名空间内的资源。您可以调用DescribeUserClusterNamespaces接口,查看当前RAM用户或角色在指定的ACK集群内被授予了哪些命名空间内资源的RBAC访问权限。
DescribeClusterLogs查询集群日志您可以调用DescribeClusterLogs接口检索集群的日志数据,以便在出现集群问题时进行根因分析和溯源。
RunClusterCheck发起集群检查容器智能运维平台提供丰富的Kubernetes集群检查能力,包括集群升级检查、集群迁移检查、组件安装检查、组件升级检查、节点池检查等。在正式执行升级、迁移或安装操作前,容器智能运维平台会自动触发检查,仅当检查通过后您才可以执行变更操作。您也可以手动调用RunClusterCheck接口执行集群检查。建议您定期对集群进行检查和维护,预防集群安全风险。
ListClusterChecks查询所有集群检查的列表容器智能运维平台提供丰富的Kubernetes集群检查能力,包括集群升级检查、集群迁移检查、组件安装检查、组件升级检查、节点池检查等。您可以调用ListClusterChecks接口,根据集群ID查询集群检查的列表和检查相关信息,例如检查类型、状态、创建和完成时间等。
GetClusterCheck查询指定集群检查的信息容器智能运维平台提供丰富的Kubernetes集群检查能力,包括集群升级检查、集群迁移检查、组件安装检查、组件升级检查、节点池检查等。您可以调用GetClusterCheck接口,根据集群ID和检查任务ID查看指定检查任务的相关信息,例如检查状态、具体检查项、检查创建和完成时间等。
ModifyCluster修改集群配置创建ACK集群后,如需修改集群的配置,您可以调用ModifyCluster接口来完成。
MigrateCluster迁移基础版集群至Pro版ACK集群Pro版是在ACK集群基础版的基础上发展而来的集群类型,继承了原托管版集群的所有优势,例如控制面托管、控制面高可用等。同时,ACK集群Pro版进一步增强了集群的可靠性、安全性和调度性,并且支持赔付标准的SLA,适合生产环境下有着大规模业务,对稳定性和安全性有高要求的企业客户。建议您将ACK集群基础版迁移至ACK集群Pro版。
DescribeClusterUserKubeconfig查询集群KubeConfigKubeConfig用于在客户端配置ACK集群的访问凭据,包含访问目标集群的身份和认证数据等信息。使用kubectl管理集群时,您需要通过KubeConfig来连接。请妥善管理集群的KubeConfig凭据,并在无需使用凭据时及时完成吊销,避免KubeConfig泄露带来的数据泄露等安全风险。
DescribeSubaccountK8sClusterUserConfig使用阿里云账号获取指定RAM用户或角色的集群KubeConfig作为集群权限管理者,您可以使用阿里云账号(主账号)为账号内指定RAM用户或RAM角色签发包含其身份信息的KubeConfig凭证,用于连接ACK集群。您可以调用DescribeSubaccountK8sClusterUserConfig接口,签发或获取账号内任意RAM用户或角色的KubeConfig。
UpdateK8sClusterUserConfigExpire更新用户自定义配置的过期时间ACK集群下发的KubeConfig过期时间默认为3年。您可以使用阿里云账号(主账号)自定义配置,调用UpdateK8sClusterUserConfigExpire接口指定RAM用户或角色在ACK集群中下发的KubeConfig的过期时间(1~876000小时)。
ScanClusterVuls扫描集群安全漏洞您可以调用ScanClusterVuls接口扫描ACK集群中潜在的安全漏洞,包括容器工作负载漏洞、三方软件漏洞、CVE漏洞、WebCMS漏洞、Windows操作系统漏洞等。建议您定期扫描集群的安全漏洞,提高集群安全性。
DescribeClusterVuls查询集群安全漏洞信息您可以根据集群ID调用DescribeClusterVuls接口查看集群的安全漏洞详细信息,包括漏洞名称、漏洞类型、漏洞等级等。建议您定期扫描集群的安全漏洞,提高集群安全性。

节点池

API标题API概述
CreateClusterNodePool创建节点池通过节点池,您可以更方便地对节点进行分组管理,例如节点运维、节点配置、开启节点自动弹性伸缩、批量管理、指定调度等。您可以调用CreateClusterNodePool为集群创建节点池。推荐您使用托管节点池,以帮助您自动完成部分节点运维操作,例如高危CVE漏洞自动修复、部分故障修复等,从而降低您的节点运维负担。
DeleteClusterNodepool删除节点池您可以调用DeleteClusterNodepool接口删除不再使用的节点池。
DescribeClusterNodePoolDetail查询节点池配置您可以根据节点池ID,调用DescribeClusterNodePoolDetail接口查询集群中目标节点池的配置。
DescribeClusterNodePools查询节点池列表您可以调用DescribeClusterNodePools接口,查询集群的节点池列表及节点池详细信息。
DescribeNodePoolVuls查询节点池漏洞您可以根据节点池ID调用DescribeNodePoolVuls接口查看节点池的安全漏洞详细信息,包括漏洞名称、漏洞等级等。建议您定期扫描节点池的安全漏洞,提高集群安全性。
ModifyClusterNodePool修改节点池配置您可以根据节点池ID,调用ModifyClusterNodePool接口更新目标节点池的配置。
ScaleClusterNodePool扩容节点池根据节点池ID,扩容节点池节点。
AttachInstancesToNodePool添加已有节点到节点池如果需要将已有ECS实例添加到ACK集群中作为Worker节点,或移除Worker节点后需将节点实例重新加入节点池,您可以调用AttachInstancesToNodePool将已有节点添加到节点池。
RemoveNodePoolNodes移除节点池节点当您不再需要集群节点继续工作时,可以调用RemoveNodePoolNodes接口将集群中的节点移出节点池,并同时调整期望节点数。移除节点时,您可以选择是否同时释放ECS、是否自动排空节点。移除节点会涉及Pod迁移,可能会影响业务,请在业务低峰期操作并提前做好相关的数据备份。
UpgradeClusterNodepool升级节点池您可以调用UpgradeClusterNodepool接口升级指定集群节点池的kubelet版本(建议与控制面版本一致)、操作系统版本或容器运行时版本。
RepairClusterNodePool修复节点池节点您可以调用RepairClusterNodePool接口修复指定集群节点池的异常节点,使节点保持正常运行状态。
FixNodePoolVuls修复节点池漏洞阿里云云安全产品会定期扫描ECS节点上的安全漏洞,并提供对应的修复建议与方法。某些CVE的修复可能需要重启节点,请确保集群有充足的节点用于排水操作。您可以调用FixNodePoolVuls接口修复指定集群节点池的节点漏洞,提高集群节点的安全性。
ModifyNodePoolNodeConfig修改节点池节点配置您可以调用ModifyNodePoolNodeConfig接口修改集群节点池中节点配置信息,例如kubelet配置、节点轮转配置等。修改节点配置会按批次变更节点配置并重启kubelet, 可能会对节点运行和工作负载运行产生一定影响,请在业务低峰期操作。
SyncClusterNodePool同步节点池您可以调用SyncClusterNodePool接口同步集群节点池,包含节点池元数据、节点池内节点信息等。
DescribeClusterAttachScripts查询添加已有节点到集群节点池的脚本如果需要将已有ECS实例添加到ACK集群中作为Worker节点,或移除Worker节点后需将节点实例重新加入节点池,ACK支持手动将已有节点到节点池。您可以调用DescribeClusterAttachScripts接口获取添加已有节点的脚本。
CreateAutoscalingConfig创建弹性伸缩配置您可以创建自动弹性伸缩配置,让系统能够按照配置的伸缩规则自动增加或减少计算资源,满足您的集群工作负载的需求。创建过程中,您可以指定扩缩容的度量指标和阈值、扩容顺序、静默时间等。

节点

API标题API概述
DescribeClusterNodes查询集群节点列表您可以调用DescribeClusterNodes接口,查询符合条件的节点列表信息。
DeleteClusterNodes移除集群节点当您不再需要集群节点继续工作时,可以调用DeleteClusterNodes接口将集群中的节点移出集群。移除节点时,您可以选择是否同时释放ECS、是否自动排空节点。移除节点会涉及Pod迁移,可能会影响业务,请在业务低峰期操作并提前做好相关的数据备份。

组件

API标题API概述
InstallClusterAddons安装集群组件为了增强Kubernetes能力,ACK集群支持了多种组件,例如托管的核心组件,应用、日志和监控、网络、存储、安全组件等。您可以调用InstallClusterAddons接口,通过组件名称和版本安装组件。
UnInstallClusterAddons卸载集群组件当您无需使用集群某些组件时,您可以调用UnInstallClusterAddons接口指定组件名称,删除组件,并选择是否删除关联的阿里云云资源。
DescribeAddons查询集群组件详情查询平台支持的所有组件的详情。
DescribeClusterAddonsVersion查询集群组件版本根据集群ID,查询集群中已安装的所有组件的详情。
DescribeClusterAddonInstance查询集群组件实例信息调用DescribeClusterAddonInstance查询已安装的集群组件的版本、状态和配置等信息。
ListAddons查询可用的组件列表您可以调用ListAddons接口,根据指定地域、集群类型、集群子类型(profile)、集群版本等参数获取可用组件的列表,并查询组件的详细信息,包括组件托管与否、支持的自定义参数Schema、兼容的操作系统架构等。
ListClusterAddonInstances查询集群已安装的组件实例列表您可以调用ListClusterAddonInstances接口获取目标集群已安装的组件实例列表并查询组件实例的相关信息,包括组件版本、状态等。
GetClusterAddonInstance查询集群内指定组件实例信息您可以调用GetClusterAddonInstance接口查询集群中目标组件的详细信息,包括目标组件实例的版本、参数配置、日志功能启用状态等。
DescribeAddon查询指定组件的信息您可以调用DescribeAddon接口,根据指定地域、集群类型、集群子类型(profile)、集群版本、组件名称等参数查询目标组件的信息,包括组件托管与否、组件分类、支持的自定义参数Schema、兼容的操作系统架构、该版本要求的最低集群版本等。
ModifyClusterAddon修改集群组件实例配置您可以调用ModifyClusterAddon配置修改已安装的集群组件实例的配置。修改配置可能会影响业务,请评估影响后在业务低峰期操作并提前做好相关的数据备份。
DescribeClusterAddonMetadata查询集群组件元数据调用DescribeClusterAddonMetadata查询特定集群可使用的指定组件版本信息,包括组件版本、可配置参数等。
UpgradeClusterAddons升级集群实例组件您可以调用UpgradeClusterAddons接口升级集群组件实例的版本,从而享受新版本带来的功能优化、缺陷修复等。请依次逐个组件升级,确认一个组件升级成功后再升级下一个组件。升级组件前,请了解每个组件升级的注意事项。升级集群组件实例版本可能会影响业务,请评估影响后在业务低峰期操作并提前做好相关的数据备份。
DescribeClusterAddonsUpgradeStatus查询集群组件升级状态根据组件名称查询该组件升级状态。

升级

API标题API概述
UpgradeCluster升级集群为避免过期版本集群潜在的安全和稳定性风险,同时享用新集群版本的新功能,请随ACK集群的版本发布节奏升级集群。升级集群前,请参考Kubernetes版本说明帮助文档了解待升级版本的版本解读、废弃资源API、升级注意事项等,避免因高版本的功能变更导致业务功能不兼容,继而影响集群正常运行。升级集群前请先进行集群升级检查。升级集群版本可能会影响业务,请评估影响后在业务低峰期操作并提前做好相关的数据备份。
GetUpgradeStatus查询集群升级状态根据集群ID,查询该集群的升级状态。
PauseClusterUpgrade暂停集群升级暂停用户集群升级。
CancelClusterUpgrade取消集群升级取消处于升级状态的ACK集群。
ResumeUpgradeCluster重新开始集群升级根据集群ID,恢复升级处于升级暂停状态的集群。

权限

API标题API概述
DescribeUserPermission查询RAM用户或角色的集群授权信息在ACK集群中,您可以创建并指定不同RAM用户或角色拥有不同的访问权限,从而确保安全访问控制和资源隔离。您可以调用DescribeUserPermission接口查询RAM用户或角色拥有的集群权限详情,包括可访问的资源、权限的作用范围、预置的角色类型、权限来源等。
GrantPermissions全量更新RAM用户或角色的集群授权信息在ACK集群中,非集群创建者或阿里云账号(主账号)在集群中默认没有任何RBAC权限。您可以调用GrantPermissions接口,更新RAM用户或角色拥有的RBAC访问权限,包括可访问的资源、权限的作用范围、预置的角色类型等,从而更好地管理集群的安全访问控制。

编排模版

API标题API概述
CreateTemplate创建编排模板编排模板是对一组Kubernetes集群资源的定义和描述,以声明性方式描述应用应该如何运行或者配置。您可以基于这些模板自动化部署和管理集群中的资源,例如Pods、Services、Deployments、ConfigMaps、PersistentVolumes等。您可以调用CreateTemplate接口创建一个编排模板。
DescribeTemplateAttribute查询指定编排模板的详情编排模板是对一组Kubernetes集群资源的定义和描述,以声明性方式描述应用应该如何运行或者配置。您可以调用DescribeTemplateAttribute接口,查询目标编排模板的详细信息,包括访问权限、YAML内容、标签等。
DescribeTemplates查询所有编排模板编排模板是对一组Kubernetes集群资源的定义和描述,以声明性方式描述应用应该如何运行或者配置。您可以调用DescribeTemplates接口获取已创建的编排模板的列表,并查询编排模板的详细信息,包括访问权限、YAML内容、标签等。
UpdateTemplate更新编排模板编排模板是对一组Kubernetes集群资源的定义和描述,以声明性方式描述应用应该如何运行或者配置。您可以调用UpdateTemplate接口更新编排模板配置。
DeleteTemplate删除编排模板当您无需使用某些编排模板时,您可以调用DeleteTemplate接口删除编排模板。

触发器

API标题API概述
CreateTrigger创建触发器为应用创建触发器。
DeleteTrigger删除触发器删除应用触发器。
DescribeTrigger查询触发器查询指定的触发器。

标签

API标题API概述
ListTagResources查询集群的标签列表您可以为集群添加标签键值对,让集群开发或运维人员能够更灵活地对集群进行分类管理,更好的支持监控、成本分析、租户隔离等需求。您可以调用ListTagResources接口,获取资源标签的列表并查询标签的详细信息,例如键值对、绑定的集群等。
TagResources为集群绑定标签您可以为集群添加标签键值对,让集群开发或运维人员能够更灵活地对集群进行分类管理,更好的支持监控、成本分析、租户隔离等需求。您可以调用TagResources接口,为集群绑定标签。
UntagResources删除集群标签当您无需使用集群的标签键值对时,您可以调用UntagResources接口,删除资源标签。
ModifyClusterTags全量更新集群标签您可以为集群添加标签键值对,让集群开发或运维人员能够更灵活地对集群进行分类管理,更好的支持监控、成本分析、租户隔离等需求。您可以调用ModifyClusterTags接口,修改集群标签。

日志

API标题API概述
UpdateControlPlaneLog修改ACK托管集群控制面组件日志配置ACK托管集群支持收集控制面组件日志并投递到您的SLS Log Project中。控制面组件包括Kube API Server、Kube Scheduler、Kube Controller Manager、Cloud Controller Manager等核心组件。您可以调用UpdateControlPlaneLog接口,修改控制面组件日志配置,例如日志保存时间、采集的组件等。
CheckControlPlaneLogEnable查询ACK托管集群控制面组件日志配置ACK托管集群支持收集控制面组件日志并投递到您的SLS Log Project中。控制面组件包括Kube API Server、Kube Scheduler、Kube Controller Manager、Cloud Controller Manager等核心组件。您可以调用CheckControlPlaneLogEnable接口,查询控制面组件当前的日志配置,包括日志保存时间、采集的组件等。

事件

API标题API概述
DescribeEvents查询事件详情集群操作事件包括集群创建、集群变更、节点池创建、节点池扩容、Addon安装、集群升级等。您可以调用DescribeEvents接口,查询某类事件的详细信息,包括事件级别、时间状态、时间发生时间等。
DescribeClusterEvents查询指定集群的事件集群操作事件包括集群创建、集群变更、节点池创建、节点池扩容、Addon安装、集群升级等。您可以调用DescribeClusterEvents接口,获取指定集群中发生的事件列表,并查询事件的详细信息,包括事件级别、时间状态、时间发生时间等。

任务

API标题API概述
DescribeTaskInfo查询任务详情您可以调用DescribeTaskInfo接口,查询集群任务的详细信息,例如任务类型、运行状态、运行阶段等。
PauseTask暂停任务您可以调用PauseTask接口,暂停执行中的集群任务。
ResumeTask恢复任务您可以调用ResumeTask接口,恢复已暂停的集群任务。
CancelTask取消任务您可以调用CancelTask接口,取消集群任务的执行。
DescribeClusterTasks查询集群任务列表您可以调用DescribeClusterTasks接口,查询集群下的任务列表。

策略治理

API标题API概述
DeletePolicyInstance删除策略规则实例您可以调用DeletePolicyInstance接口,在指定集群中删除策略规则实例。
ModifyPolicyInstance更新策略规则实例您可以调用ModifyPolicyInstance接口,在指定集群中更新策略规则实例,调整策略实例的治理动作(告警或拦截)、作用的命名空间范围等。
DescribePolicies查询策略治理规则库列表ACK集群容器安全策略供了种类丰富的内置规则库,包括Compliance、Infra、K8s-general和PSP,旨在确保容器在生产环境中的安全运行。您可以调用DescribePolicies接口,查询策略治理规则库的列表。
DescribePolicyDetails查询指定策略治理规则的详情ACK集群容器安全策略供了种类丰富的内置规则库,包括Compliance、Infra、K8s-general和PSP,旨在确保容器在生产环境中的安全运行。您可以调用DescribePolicyDetails接口,查询指定策略治理规则的详细信息,例如规则模板描述、规则治理动作、规则治理等级等。
DescribePolicyGovernanceInCluster获取集群策略治理详情ACK集群容器安全策略供了种类丰富的内置规则库,包括Compliance、Infra、K8s-general和PSP,旨在确保容器在生产环境中的安全运行。您可以调用DescribePolicyGovernanceInCluster接口,查询目标集群策略治理的详细信息,例如集群当前启用的不同等级策略计数统计、策略治理审计日志、拦截和告警情况等。
DescribePolicyInstances查询策略实例列表您可以在ACK集群中选择安全策略类型,配置相关实施动作、作用范围等,创建并部署一个策略实例。您可以调用DescribePolicyInstances接口,获取集群中指定策略规则实例的详细信息,例如策略描述、治理等级等。
DescribePolicyInstancesStatus查看策略规则对应的实例部署详情您可以调用DescribePolicyInstancesStatus接口,查询集群当前不同策略类型对应的实例部署状态,包括每种策略规则对应开启的实例计数,以及不同治理等级下开启的策略种类计数。
DeployPolicyInstance部署策略规则实例您可以在ACK集群中选择安全策略类型,配置策略实例的治理动作(告警或拦截)、作用的命名空间范围等,以创建并部署一个策略实例。您可以调用DeployPolicyInstance接口,在指定集群的命名空间中部署策略规则实例。

其他

API标题API概述
DescribeUserQuota查询集群配额您可以调用DescribeUserQuota接口,查询ACK集群、节点池、节点的相关配额。如需扩大配额,请前往配额中心申请。
UpdateUserPermissions更新指定RAM用户/角色的RBAC权限在ACK集群中,非集群创建者或阿里云账号(主账号)在集群中默认没有任何RBAC权限。您可以调用UpdateUserPermissions接口,更新RAM用户或角色拥有的RBAC访问权限,包括可访问的资源、权限的作用范围、预置的角色类型等,从而更好地管理集群的安全访问控制。
ListOperationPlans查询自动运维任务执行计划列表
CancelOperationPlan取消自动运维任务执行计划使用CancelOperationPlan取消已存在但未执行的自动运维任务执行计划。
CheckServiceRole检查服务角色授权状态检查当前阿里云账号是否已授权指定服务角色。
GetClusterDiagnosisResult查询集群诊断结果
GetClusterDiagnosisCheckItems查询集群诊断检查项
CreateClusterDiagnosis发起集群诊断
UpdateResourcesDeleteProtection更新指定资源的删除保护状态更新指定资源的删除保护状态,当前支持开启或关闭删除保护的资源类型有namespaces和services。
DescribeResourcesDeleteProtection查询指定资源是否开启删除保护查询指定资源是否开启删除保护,当前支持查询的删除保护资源包括namespaces和services。