本產品(
容器服務Kubernetes版/2015-12-15
)的OpenAPI采用ROA簽名風格,簽名細節參見簽名機制說明。我們已經為開發者封裝了常見編程語言的SDK,開發者可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求,可通過簽名機制進行自簽名對接。由于自簽名細節非常復雜,需花費 5個工作日左右。因此建議加入我們的服務釘釘群(78410016550),在專家指導下進行簽名對接。在使用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集群(例如指定集群類型、集群規格)列表信息。 |
DescribeClustersForRegion | 查詢指定地域的集群列表 | 查詢指定地域內全部集群列表。 |
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接口來完成。 |
DescribeClusterUserKubeconfig | 查詢集群KubeConfig | KubeConfig用于在客戶端配置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小時)。 |
節點池
API | 標題 | API概述 |
---|---|---|
CreateClusterNodePool | 創建節點池 | 通過節點池,您可以更方便地對節點進行分組管理,例如節點運維、節點配置、開啟節點自動彈性伸縮、批量管理、指定調度等。您可以調用CreateClusterNodePool為集群創建節點池。推薦您使用托管節點池,以幫助您自動完成部分節點運維操作,例如高危CVE漏洞自動修復、部分故障修復等,從而降低您的節點運維負擔。 |
DeleteClusterNodepool | 刪除節點池 | 您可以調用DeleteClusterNodepool接口刪除不再使用的節點池。 |
DescribeClusterNodePoolDetail | 查詢節點池配置 | 您可以根據節點池ID,調用DescribeClusterNodePoolDetail接口查詢集群中目標節點池的配置。 |
DescribeClusterNodePools | 查詢節點池列表 | 查詢集群內所有節點池列表。 |
DescribeNodePoolVuls | 查詢節點池漏洞 | 您可以根據節點池ID調用DescribeNodePoolVuls接口查看節點池的安全漏洞詳細信息,包括漏洞名稱、漏洞等級等。建議您定期掃描節點池的安全漏洞,提高集群安全性。 |
ModifyClusterNodePool | 修改節點池配置 | 您可以根據節點池ID,調用ModifyClusterNodePool接口更新目標節點池的配置。 |
ScaleClusterNodePool | 擴容節點池 | 您可以調用ScaleClusterNodePool對節點進行擴容,以保證節點數量足夠支撐業務運行。 |
AttachInstancesToNodePool | 添加已有節點到節點池 | 如果需要將已有ECS實例添加到ACK集群中作為Worker節點,或移除Worker節點后需將節點實例重新加入節點池,您可以調用AttachInstancesToNodePool將已有節點添加到節點池。 |
RemoveNodePoolNodes | 移除節點池節點 | 當您不再需要集群節點繼續工作時,可以調用RemoveNodePoolNodes接口將集群中的節點移出節點池,并同時調整期望節點數。移除節點時,您可以選擇是否同時釋放ECS、是否自動排空節點。移除節點會涉及Pod遷移,可能會影響業務,請在業務低峰期操作并提前做好相關的數據備份。 |
UpgradeClusterNodepool | 升級節點池 | 您可以調用UpgradeClusterNodepool接口升級指定集群節點池的kubelet版本(建議與控制面版本一致)、操作系統版本或容器運行時版本。 |
RepairClusterNodePool | 修復節點池節點 | 修復集群節點池。 |
FixNodePoolVuls | 修復節點池漏洞 | 阿里云云安全產品會定期掃描ECS節點上的安全漏洞,并提供對應的修復建議與方法。某些CVE的修復可能需要重啟節點,請確保集群有充足的節點用于排水操作。您可以調用FixNodePoolVuls接口修復指定集群節點池的節點漏洞,提高集群節點的安全性。 |
ModifyNodePoolNodeConfig | 修改節點池節點配置 | 您可以調用ModifyNodePoolNodeConfig接口修改集群節點池中節點配置信息,例如kubelet配置、節點輪轉配置等。修改節點配置會按批次變更節點配置并重啟kubelet, 可能會對節點運行和工作負載運行產生一定影響,請在業務低峰期操作。 |
SyncClusterNodePool | 同步節點池 | 您可以調用SyncClusterNodePool接口同步集群節點池,包含節點池元數據、節點池內節點信息等。 |
DescribeClusterAttachScripts | 查詢添加已有節點到集群節點池的腳本 | 如果需要將已有ECS實例添加到ACK集群中作為Worker節點,或移除Worker節點后需將節點實例重新加入節點池,ACK支持手動將已有節點到節點池。您可以調用DescribeClusterAttachScripts接口獲取添加已有節點的腳本。 |
CreateAutoscalingConfig | 創建彈性伸縮配置 | 您可以創建自動彈性伸縮配置,讓系統能夠按照配置的伸縮規則自動增加或減少計算資源,滿足您的集群工作負載的需求。創建過程中,您可以指定擴縮容的度量指標和閾值、擴容順序、靜默時間等。 |
節點
API | 標題 | API概述 |
---|---|---|
DescribeClusterNodes | 查詢集群節點列表 | 您可以調用DescribeClusterNodes接口,查詢符合條件的節點列表信息。 |
組件
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訪問權限,包括可訪問的資源、權限的作用范圍、預置的角色類型等,從而更好地管理集群的安全訪問控制。 |
UpdateUserPermissions | 更新指定RAM用戶/角色的RBAC權限 | 在ACK集群中,非集群創建者或阿里云賬號(主賬號)在集群中默認沒有任何RBAC權限。您可以調用UpdateUserPermissions接口,更新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 | 創建觸發器 | 您可以為集群應用配置觸發器的功能,指定觸發器在接收到某些條件時重新部署Pod。 |
DeleteTrigger | 刪除觸發器 | 當您不再需要觸發器時,可以調用DeleteTrigger刪除應用觸發器。 |
DescribeTrigger | 查詢觸發器 | 您可以調用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概述 |
---|---|---|
DescribeEventsForRegion | 查詢指定地域的事件列表 | 查詢指定地域內全部事件列表。 |
DescribeEvents | 查詢事件詳情 | 集群操作事件包括集群創建、集群變更、節點池創建、節點池擴容、Addon安裝、集群升級等。您可以調用DescribeEvents接口,查詢某類事件的詳細信息,包括事件級別、時間狀態、事件發生時間等。 |
DescribeClusterEvents | 查詢指定集群的事件 | 集群操作事件包括集群創建、集群變更、節點池創建、節點池擴容、Addon安裝、集群升級等。您可以調用DescribeClusterEvents接口,獲取指定集群中發生的事件列表,并查詢事件的詳細信息,包括事件級別、時間狀態、時間發生時間等。 |
任務
API | 標題 | API概述 |
---|---|---|
DescribeTaskInfo | 查詢任務詳情 | 您可以調用DescribeTaskInfo接口,查詢集群任務的詳細信息,例如任務類型、運行狀態、運行階段等。 |
PauseTask | 暫停任務 | 您可以調用PauseTask接口,暫停執行中的集群任務。 |
ResumeTask | 恢復任務 | 您可以調用ResumeTask接口,恢復已暫停的集群任務。 |
CancelTask | 取消任務 | 您可以調用CancelTask接口,取消集群任務的執行。 |
DescribeClusterTasks | 查詢集群任務列表 | 您可以調用DescribeClusterTasks接口,查詢集群下的任務列表。 |
策略治理
API | 標題 | API概述 |
---|---|---|
DescribePolicyInstances | 查詢策略實例列表 | 您可以在ACK集群中選擇安全策略類型,配置相關實施動作、作用范圍等,創建并部署一個策略實例。您可以調用DescribePolicyInstances接口,獲取集群中指定策略規則實例的詳細信息,例如策略描述、治理等級等。 |
DescribePolicyInstancesStatus | 查看策略規則對應的實例部署詳情 | 您可以調用DescribePolicyInstancesStatus接口,查詢集群當前不同策略類型對應的實例部署狀態,包括每種策略規則對應開啟的實例計數,以及不同治理等級下開啟的策略種類計數。 |
其他
API | 標題 | API概述 |
---|---|---|
DescribeUserQuota | 查詢集群配額 | 您可以調用DescribeUserQuota接口,查詢ACK集群、節點池、節點的相關配額。如需擴大配額,請前往配額中心申請。 |
ListOperationPlans | 查詢自動運維任務執行計劃列表 | 獲取自動運維執行計劃列表。 |
CancelOperationPlan | 取消自動運維任務執行計劃 | 使用CancelOperationPlan取消已存在但未執行的自動運維任務執行計劃。 |