API標準及多語言預置SDK
本產品(CS/2015-12-15)的OpenAPI採用ROA簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK,開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求,可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜,需花費 5個工作日左右。因此建議加入我們的服務DingTalk群(147535001692),在專家指導下進行簽名對接。
在使用API前,您需要準備好身份帳號及存取金鑰(AccessKey),才能有效通過用戶端工具(SDK、CLI等)訪問API。細節請參見擷取AccessKey。
自訂簽名情境
若您的業務情境有特殊需求,需通過自簽名方式對接 API,建議優先諮詢我們的支援人員團隊(服務DingTalk群:147535001692),擷取專業指導以確保高效接入。
帳號與安全準備
阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露,所有相關資源都將面臨未經授權訪問的風險。為確保安全,建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey,同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下,才使用阿里雲帳號。
API目錄
|
API |
標題 |
API概述 |
| OpenAckService | 開通容器服務Kubernetes版 | 首次使用容器服務Kubernetes版(Alibaba Cloud Container Service for Kubernetes,簡稱容器服務ACK)時,您需要呼叫OpenAckService介面開通服務。 |
| DescribeRegions | 查詢地域列表 | 查詢地域列表 |
叢集
|
API |
標題 |
API概述 |
| CreateCluster | 建立叢集 | 您可以透過 OpenAPI 建立 ACK 叢集,包含 ACK 託管叢集、ACK Serverless 叢集、ACK Edge 叢集以及註冊叢集。建立叢集時,您將完成叢集資訊、叢集元件以及 ACK 相關雲端資源的設定。 |
| DeleteCluster | 刪除叢集 | 如果您的叢集無需使用,請刪除叢集並選擇是否刪除或保留叢集的相關資源。刪除叢集前,請手動清理工作負載(無狀態、有狀態、任務和定時任務),否則可能導致叢集刪除失敗。 |
| ModifyCluster | 修改叢集配置 | 您可以呼叫ModifyCluster介面修改ACK叢集的配置。 |
| UpgradeCluster | 升級叢集 | 為避免過期版本叢集潛在的安全和穩定性風險,同時享用新叢集版本的新功能,請隨ACK叢集的版本發佈節奏升級叢集。您可以呼叫UpgradeCluster介面手動升級叢集。 |
| 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介面擷取叢集的日誌資料,以便在出現叢集問題時進行根本原因分析和追溯。 |
| DescribeUserQuota | 查詢叢集配額 | 您可以呼叫DescribeUserQuota介面,查詢ACK叢集、節點池、節點的相關配額。如需擴大配額,請前往配額中心申請。 |
| MigrateCluster | 遷移基礎版叢集至Pro版 | ACK叢集Pro版是在ACK叢集基礎版的基礎上發展而來的叢集類型,繼承了原託管版叢集的所有優勢,例如控制面託管、控制面高可用等。同時,ACK叢集Pro版進一步增強了叢集的可靠性、安全性和排程性,並且支援賠付標準的SLA,適合生產環境下有著大規模業務,對穩定性和安全性有高要求的企業客戶。您可以呼叫MigrateCluster介面將ACK叢集基礎版遷移至ACK叢集Pro版。 |
| DescribeClusterUserKubeconfig | 查詢叢集KubeConfig | KubeConfig用於在客戶端配置ACK叢集的訪問憑據,包含訪問目標叢集的身份和認證資料等資訊。使用kubectl管理叢集時,需要先透過KubeConfig來連線叢集,您可以呼叫DescribeClusterUserKubeconfig介面查詢指定叢集的KubeConfig。 |
| DescribeSubaccountK8sClusterUserConfig | 使用阿里雲帳號取得指定RAM使用者或角色的叢集KubeConfig | 作為叢集權限管理者,您可以使用阿里雲帳號(主帳號)為帳號內指定RAM使用者或RAM角色簽發包含其身分資訊的KubeConfig憑證,用於連線ACK叢集。您可以呼叫DescribeSubaccountK8sClusterUserConfig介面,簽發或取得帳號內任意RAM使用者或角色的KubeConfig。 |
| ListUserKubeConfigStates | 取得指定使用者所有叢集的 KubeConfig 狀態清單 | 如果您需要檢視目前使用者各個叢集KubeConfig的下發情況,您可以呼叫ListUserKubeConfigStates介面來取得目前使用者所有叢集的KubeConfig狀態清單。 |
| ListClusterKubeconfigStates | 取得指定叢集已頒發的KubeConfig清單 | 如果您需要查看目前叢集的存取控制情況,您可以呼叫ListClusterKubeconfigStates介面來取得目前叢集已下發使用者KubeConfig的清單以及狀態。 |
| UpdateK8sClusterUserConfigExpire | 更新使用者自訂配置的過期時間 | ACK 叢集下發的 KubeConfig 過期時間預設為 3 年。您可以使用阿里雲帳號(主帳號)自訂配置,呼叫 UpdateK8sClusterUserConfigExpire 介面指定 RAM 使用者或角色在 ACK 叢集中下發的 KubeConfig 的過期時間(1~876000 小時)。 |
| RevokeK8sClusterKubeConfig | 吊銷當前登入使用者KubeConfig | 如果您希望吊銷當前登入的阿里雲帳號/RAM使用者所擁有的叢集KubeConfig憑證,您可以呼叫RevokeK8sClusterKubeConfig介面進行吊銷。吊銷成功後,叢集會產生新的KubeConfig,原來的KubeConfig會失效。 |
| CleanClusterUserPermissions | 清理指定使用者在指定叢集已下發KubeConfig憑證和RBAC權限 | 如果您想針對部分有安全風險的KubeConfig進行清理和解除授權,您可以呼叫CleanClusterUserPermissions清理指定使用者在指定叢集已下發的KubeConfig憑證和RBAC權限。 |
| CleanUserPermissions | 清理指定使用者在所有叢集已下發KubeConfig憑據和RBAC權限 | 如果您想針對部分風險使用者(已離職、帳號凍結等)的KubeConfig進行清理並解除授權,您可以呼叫CleanUserPermissions清理指定使用者已下發的KubeConfig憑據和RBAC權限。 |
節點集區
|
API |
標題 |
API概述 |
| CreateClusterNodePool | 建立節點池 | 節點池是具有相同屬性的一組節點的邏輯集合,允許對節點進行統一的管理和維運,例如節點升級、彈性伸縮等。您可以進一步使用節點池的自動化維運能力,使用 OS CVE 漏洞自動修復、故障節點自動恢復、kubelet 和 containerd 版本自動升級等功能,降低維運成本。您可以呼叫 CreateClusterNodePool 為叢集建立節點池。 |
| DeleteClusterNodepool | 刪除節點池 | 您可以調用DeleteClusterNodepool介面刪除不再使用的節點池。節點池刪除時所有節點上的Pod將會被刪除,並可能觸發重新調度,如無法調度可能影響業務,請確保叢集有足夠的資源進行重新調度。 |
| 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 介面,查詢符合條件的節點列表資訊。 |
| DeleteClusterNodes | 移除叢集節點 | 當您不再需要叢集節點繼續運作時,可以呼叫DeleteClusterNodes介面將叢集中的節點移出叢集。移除節點時,您可以選擇是否同時釋放ECS、是否自動排空節點。 |
| AttachInstances | 新增已有ECS執行個體到叢集 | 如果購買ECS執行個體後需要將該雲端伺服器新增到ACK叢集中作為Worker節點,或移除Worker節點後需將節點執行個體重新加入節點池,您可以呼叫AttachInstances介面,將已有ECS執行個體新增到ACK叢集。 |
元件
|
API |
標題 |
API概述 |
| InstallClusterAddons | 安裝叢集組件 | 為了增強 Kubernetes 能力,ACK 叢集支援了多種組件,例如託管的核心組件,應用、日誌和監控、網路、儲存、安全組件等。您可以呼叫 InstallClusterAddons 介面,透過組件名稱和版本安裝組件。 |
| UnInstallClusterAddons | 卸載叢集元件 | 當您無需使用叢集某些元件時,您可以呼叫UnInstallClusterAddons介面指定元件名稱,刪除元件,並選擇是否刪除關聯的阿里雲雲端資源。 |
| ListAddons | 查詢可用的元件列表 | 您可以呼叫ListAddons介面,根據指定地域、叢集類型、叢集子類型(profile)、叢集版本等參數取得可用元件的列表,並查詢元件的詳細資訊,包括元件託管與否、支援的自訂參數Schema、相容的作業系統架構等。 |
| ListClusterAddonInstances | 查詢叢集已安裝的元件實例清單 | 您可以呼叫ListClusterAddonInstances介面取得目標叢集已安裝的元件實例清單並查詢元件實例的相關資訊,包括元件版本、狀態等。 |
| GetClusterAddonInstance | 查詢叢集內指定元件實例資訊 | 您可以呼叫GetClusterAddonInstance介面查詢叢集中目標元件的詳細資訊,包括目標元件實例的版本、參數配置、日誌功能啟用狀態等。 |
| DescribeAddon | 查詢指定組件的資訊 | 您可以呼叫 DescribeAddon 介面,根據指定地域、叢集類型、叢集子類型(profile)、叢集版本、組件名稱等參數查詢目標組件的資訊,包括組件託管與否、組件分類、支援的自訂參數 Schema、相容的作業系統架構、該版本要求的最低叢集版本等。 |
| ModifyClusterAddon | 修改叢集元件實例設定 | 您可以呼叫ModifyClusterAddon設定修改已安裝的叢集元件實例的設定。修改設定可能會影響業務,請評估影響後在業務低峰期操作並提前做好相關的資料備份。 |
| UpgradeClusterAddons | 升級叢集執行個體元件 | 您可以呼叫UpgradeClusterAddons介面升級叢集元件執行個體的版本,從而享受新版本帶來的功能最佳化體驗。 |
| ListClusterAddonInstanceResources | 查詢叢集元件例項的資源 | 查詢已安裝的叢集元件例項所包含的資源列表,包括Kubernetes叢集資源、Helm釋出例項等。 |
權限
|
API |
標題 |
API概述 |
| DescribeUserPermission | 查詢RAM使用者或角色的叢集授權資訊 | 在ACK叢集中,您可以建立並指定不同RAM使用者或角色擁有不同的存取權限,從而確保安全存取控制和資源隔離。您可以呼叫DescribeUserPermission介面查詢RAM使用者或角色擁有的叢集權限詳情,包括可存取的資源、權限的作用範圍、預置的角色類型、權限來源等。 |
| GrantPermissions | 全量更新RAM使用者或角色的叢集授權資訊 | 非叢集建立者、未被授予過所有叢集維度權限的RAM使用者或角色在叢集中預設沒有任何RBAC權限。您可以呼叫GrantPermissions介面,更新RAM使用者或角色擁有的RBAC存取權限,包括可存取的資源、權限的作用範圍、預置的角色類型等,從而更好地管理叢集的安全存取控制。 |
| UpdateUserPermissions | 更新指定 RAM 使用者/角色的 RBAC 權限 | 在 ACK 叢集中,非叢集建立者、RAM 使用者以及 RAM 角色在叢集中預設沒有任何 RBAC 權限。您可以呼叫 UpdateUserPermissions 介面,更新 RAM 使用者或角色擁有的 RBAC 存取權限,包括可存取的資源、權限的作用範圍、預置的角色類型等,從而更好地管理叢集的安全存取控制。 |
| CheckServiceRole | 檢查服務角色授權狀態 | 檢查目前服務帳號是否已授予指定的服務角色權限。只有授予對應的角色權限後,容器服務才能正常呼叫服務角色相關的其他雲端服務(ECS、OSS、NAS、SLB等)。 |
安全性
|
API |
標題 |
API概述 |
| ScanClusterVuls | 掃描叢集安全漏洞 | 您可以呼叫 ScanClusterVuls 介面掃描 ACK 叢集中潛在的安全漏洞,包括容器工作負載漏洞、第三方軟體漏洞、CVE 漏洞、WebCMS 漏洞、Windows 作業系統漏洞等。建議您定期掃描叢集的安全漏洞,提高叢集安全性。 |
| DescribeClusterVuls | 查詢叢集安全漏洞資訊 | 您可以根據叢集ID呼叫DescribeClusterVuls介面查看叢集的安全漏洞詳細資訊,包括漏洞名稱、漏洞類型、漏洞等級等。建議您定期掃描叢集的安全漏洞,提高叢集安全性。 |
| UpdateResourcesDeleteProtection | 更新指定資源的刪除保護狀態 | 更新指定資源的刪除保護狀態,目前支援的資源類型有命名空間和服務。 透過本介面,您可以為涉及關鍵業務、敏感資料的命名空間或服務開啟刪除保護功能,以避免誤刪除帶來的維護成本。 |
| DescribeResourcesDeleteProtection | 查詢指定資源是否開啟刪除保護 | 查詢叢集內的指定資源是否開啟刪除保護,目前支援刪除保護的資源包括命名空間和服務。 |
| DeployPolicyInstance | 部署策略規則執行個體 | 您可以在 ACK 叢集中選擇安全性原則類型,配置原則執行個體的治理動作(告警或攔截)、作用的命名空間範圍等,以建立並部署一個原則執行個體。您可以呼叫 DeployPolicyInstance 介面,在指定叢集的命名空間中部署策略規則執行個體。 |
| ModifyPolicyInstance | 更新策略規則執行個體 | 您可以呼叫ModifyPolicyInstance介面,在指定叢集中更新策略規則執行個體,調整策略執行個體的治理動作(告警或攔截)、作用的命名空間範圍等。 |
| DeletePolicyInstance | 刪除原則規則執行個體 | 您可以呼叫DeletePolicyInstance介面,在指定叢集中刪除原則規則執行個體。 |
| 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 API,取得叢集中指定原則規則執行個體的詳細資訊,例如原則描述、治理等級等。 |
| DescribePolicyInstancesStatus | 查看策略規則對應的執行個體部署詳情 | 您可以呼叫DescribePolicyInstancesStatus介面,查詢叢集目前不同策略類型對應的執行個體部署狀態,包括每種策略規則對應開啟的執行個體計數,以及不同治理等級下開啟的策略種類計數。 |
叢集檢查/巡檢/診斷
|
API |
標題 |
API概述 |
| RunClusterCheck | 發起叢集檢查 | 容器智慧維運平台提供豐富的Kubernetes叢集檢查能力,包括叢集升級檢查、叢集遷移檢查、元件安裝檢查、元件升級檢查、節點池檢查等。在正式執行升級、遷移或安裝操作前,容器智慧維運平台會自動觸發檢查,僅當檢查通過後您才可以執行變更操作。您也可以手動呼叫RunClusterCheck介面執行叢集檢查。建議您定期對叢集進行檢查和維護,預防叢集安全風險。 |
| ListClusterChecks | 查詢所有叢集檢查的清單 | 容器智慧維運平台提供豐富的Kubernetes叢集檢查能力,包括叢集升級檢查、叢集移轉檢查、元件安裝檢查、元件升級檢查、節點池檢查等。您可以呼叫ListClusterChecks介面,根據叢集ID查詢叢集檢查的清單和檢查相關資訊,例如檢查類型、狀態、建立和完成時間等。 |
| GetClusterCheck | 查詢指定叢集檢查的資訊 | 容器智慧維運平台提供豐富的Kubernetes叢集檢查能力,包括叢集升級檢查、叢集遷移檢查、元件安裝檢查、元件升級檢查、節點池檢查等。您可以呼叫GetClusterCheck介面,根據叢集ID和檢查任務ID檢視指定檢查任務的相關資訊,例如檢查狀態、具體檢查項、檢查建立和完成時間等。 |
| CreateClusterInspectConfig | 建立叢集巡檢設定 | 建立叢集巡檢設定。 |
| UpdateClusterInspectConfig | 更新叢集巡檢設定 | 更新叢集巡檢設定 |
| GetClusterInspectConfig | 取得叢集巡檢設定 | 取得叢集巡檢設定 |
| RunClusterInspect | 建立叢集巡檢報告 | 發起叢集巡檢,建立巡檢報告。 |
| ListClusterInspectReports | 取得叢集巡檢報告列表 | 取得叢集巡檢報告列表。 |
| GetClusterInspectReportDetail | 獲取叢集巡檢報告詳情 | 獲取叢集巡檢報告詳情 |
| DeleteClusterInspectConfig | 刪除叢集巡檢設定 | 刪除叢集巡檢設定 |
| CreateClusterDiagnosis | 發起叢集診斷 | 發起叢集診斷。 |
| GetClusterDiagnosisResult | 查詢叢集診斷結果 | 取得叢集診斷結果。 |
| GetClusterDiagnosisCheckItems | 查詢叢集診斷檢查項 | 取得叢集診斷檢查項。 |
編排範本
|
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概述 |
| StartAlert | 啟動告警規則 | 啟動指定的告警規則。 |
| UpdateContactGroupForAlert | 更新告警項聯絡人分組 | 您可以呼叫UpdateContactGroupForAlert介面,為ACK叢集中的告警規則集設定指定的聯絡人分組。 |
| StopAlert | 停止警報規則 | 停止ACK警報中心中警報規則,停止整個警報規則集分組、單個警報規則。 |
| DeleteAlertContact | 刪除警報聯絡人 | 刪除ACK警報聯絡人 |
| DeleteAlertContactGroup | 刪除警報聯絡人分組 | 刪除ACK警報聯絡人分組 |
日誌
|
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介面,查詢控制面元件目前的日誌配置,包括日誌儲存時間、採集的元件等。 |
| GetClusterAuditProject | 取得叢集API Server稽核日誌SLS Project | 您可以呼叫GetClusterAuditProject檢視叢集是否開啟API Server稽核功能以及API Server稽核日誌對應的SLS Project。 |
| UpdateClusterAuditLogConfig | 更新叢集稽核日誌配置 | 當您需要記錄對 Kubernetes API 的請求以及請求結果來用於追溯叢集操作歷史、排查叢集故障時,您可以呼叫 UpdateClusterAuditLogConfig 介面來開啟、關閉指定 ACK 叢集的稽核日誌功能、更新稽核日誌配置。 |
事件
|
API |
標題 |
API概述 |
| DescribeEventsForRegion | 查詢指定地域的事件列表 | 查詢指定地域內全部事件列表。 |
| DescribeEvents | 查詢事件詳情 | 叢集操作事件包括叢集建立、叢集變更、節點池建立、節點池擴容、Addon安裝、叢集升級等。您可以呼叫DescribeEvents介面,查詢某類事件的詳細資訊,包括事件級別、時間狀態、事件發生時間等。 |
| DescribeClusterEvents | 查詢指定叢集的事件 | 叢集操作事件包括叢集建立、叢集變更、節點池建立、節點池擴容、Addon安裝、叢集升級等。您可以呼叫DescribeClusterEvents介面,取得指定叢集中發生的事件列表,並查詢事件的詳細資訊,包括事件等級、時間狀態、時間發生時間等。 |
任務
|
API |
標題 |
API概述 |
| DescribeTaskInfo | 查詢任務詳情 | 您可以呼叫DescribeTaskInfo介面,查詢叢集任務的詳細資訊,例如任務類型、執行狀態、執行階段等。 |
| PauseTask | 暫停任務 | 您可以呼叫PauseTask介面,暫停執行中的叢集任務。 |
| ResumeTask | 恢復任務 | 您可以呼叫ResumeTask介面,恢復已暫停的叢集任務。 |
| CancelTask | 取消任務 | 您可以呼叫CancelTask介面,取消叢集任務的執行。 |
| DescribeClusterTasks | 查詢叢集任務列表 | 您可以呼叫DescribeClusterTasks介面,查詢叢集下的任務列表。 |
維運計畫
|
API |
標題 |
API概述 |
| ListOperationPlansForRegion | 查詢指定地域自動維運任務執行計畫列表 | 查詢指定地域內最近100條自動維運執行計畫列表。開啟叢集智慧託管模式Auto Mode、叢集自動升級、節點池自動化維運等功能時,您可以透過該介面查詢由系統自動產生的維運計畫及其執行情況,例如叢集升級、節點池CVE修復等。 |
| ListOperationPlans | 查詢自動運維任務執行計劃列表 | 獲取自動運維執行計劃列表。 |
| CancelOperationPlan | 取消自動維運任務執行計畫 | 使用CancelOperationPlan取消已存在但未執行的自動維運任務執行計畫。 |
其他
|
API |
標題 |
API概述 |
| GetUpgradeStatus | (已廢棄)查詢叢集升級狀態 | 根據叢集ID,查詢該叢集的升級狀態。 |
| PauseClusterUpgrade | (已廢棄)暫停叢集升級 | 暫停使用者叢集升級。 |
| CancelClusterUpgrade | (已廢棄)取消叢集升級 | 取消處於升級狀態的ACK叢集。 |
| ResumeUpgradeCluster | (已廢棄)重新開始叢集升級 | 根據叢集 ID,恢復升級處於升級暫停狀態的叢集。 |
| DescribeAddons | (已棄用)查詢叢集元件詳情 | 查詢平台支援的所有元件的詳情。 |
| DescribeClusterAddonsVersion | (已廢棄)查詢叢集元件版本 | 根據叢集ID,查詢叢集中已安裝的所有元件的詳情。 |
| DescribeClusterAddonInstance | (已淘汰)查詢叢集元件執行個體資訊 | 呼叫DescribeClusterAddonInstance查詢已安裝的叢集元件的版本、狀態和組態等資訊。 |
| DescribeClusterAddonMetadata | (已廢棄)查詢叢集元件中繼資料 | 呼叫DescribeClusterAddonMetadata查詢特定叢集可使用的指定元件版本資訊,包括元件版本、可配置參數等。 |
| DescribeClusterAddonsUpgradeStatus | (已廢棄)查詢叢集組件升級狀態 | 根據組件名稱查詢該組件升級狀態。 |
| UpdateNodePoolComponent | 更新節點組件 | 更新節點組件。 |
| InstallNodePoolComponents | 安裝節點組件。 | 安裝節點組件,支援配置並指定節點安裝節點組件。 |
| UpdateKMSEncryption | 更新 Secret 落盤加密功能配置 | 根據叢集 ID,更新指定叢集的 Secret 落盤加密功能配置。 |
| CreateAutoRepairPolicy | 建立自癒規則 | 建立自癒規則。 |
| DeleteAutoRepairPolicy | 刪除自癒規則 | 刪除自癒規則。 |
| ModifyAutoRepairPolicy | 修改自癒規則 | 修改自癒規則。 |
| DescribeAutoRepairPolicy | 查詢自癒規則 | 查詢自癒規則。 |
| ListAutoRepairPolicies | 取得自癒規則清單 | 取得自癒規則清單。 |