本產(chǎn)品（
容器服務(wù)Kubernetes版/2015-12-15）的OpenAPI采用ROA簽名風(fēng)格，簽名細(xì)節(jié)參見簽名機制說明。我們已經(jīng)為開發(fā)者封裝了常見編程語言的SDK，開發(fā)者可通過下載SDK直接調(diào)用本產(chǎn)品OpenAPI而無需關(guān)心技術(shù)細(xì)節(jié)。如果現(xiàn)有SDK不能滿足使用需求，可通過簽名機制進(jìn)行自簽名對接。由于自簽名細(xì)節(jié)非常復(fù)雜，需花費 5個工作日左右。因此建議加入我們的服務(wù)釘釘群（78410016550），在專家指導(dǎo)下進(jìn)行簽名對接。在使用API前，您需要準(zhǔn)備好身份賬號及訪問密鑰（AccessKey），才能有效通過客戶端工具（SDK、CLI等）訪問API。細(xì)節(jié)請參見獲取AccessKey。
API目錄
| API | 標(biāo)題 | API概述 |
|---|---|---|
| OpenAckService | 開通容器服務(wù)Kubernetes版 | 首次使用容器服務(wù)Kubernetes版（Alibaba Cloud Container Service for Kubernetes，簡稱容器服務(wù)ACK）時，您需要使用阿里云賬號（主賬號）或有相應(yīng)權(quán)限的RAM用戶（子賬號）開通并授權(quán)容器服務(wù)。 |
集群
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateCluster | 創(chuàng)建集群 | 您可以通過OpenAPI創(chuàng)建ACK集群，包含ACK托管集群、ACK專有集群、ACK Serverless集群，ACK Edge集群以及注冊集群。創(chuàng)建集群時，您將完成集群信息、集群組件以及ACK相關(guān)云資源的配置。 |
| DeleteCluster | 刪除集群 | 如果您的集群無需使用，請刪除集群并選擇是否刪除或保留集群的相關(guān)資源。刪除集群前，請手動清理工作負(fù)載（無狀態(tài)、有狀態(tài)、任務(wù)和定時任務(wù)），否則可能導(dǎo)致集群刪除失敗。 |
| DescribeClustersV1 | 查詢集群列表 | 您可以調(diào)用DescribeClustersV1接口查看本賬號下符合條件的ACK集群（例如指定集群類型、集群規(guī)格）列表信息。 |
| DescribeClustersForRegion | 查詢指定地域的集群列表 | 查詢指定地域內(nèi)全部集群列表。 |
| DescribeClusterDetail | 查詢指定集群的信息 | 您可以調(diào)用DescribeClusterDetail接口，根據(jù)集群ID查詢指定集群的詳細(xì)信息。 |
| DescribeClusterResources | 查詢指定集群的關(guān)聯(lián)資源 | 您在使用容器服務(wù) Kubernetes 版過程中，會同時使用其他關(guān)聯(lián)的阿里云云產(chǎn)品資源。您可以調(diào)用DescribeClusterResources接口查詢指定集群的關(guān)聯(lián)資源，例如VPC、SLB等。如果您需要查詢節(jié)點池或節(jié)點資源，您可以調(diào)用DescribeClusterNodePools或DescribeClusterNodes接口。 |
| DescribeKubernetesVersionMetadata | 查詢Kubernetes版本的詳細(xì)詳情 | 您可以調(diào)用DescribeKubernetesVersionMetadata接口查詢Kubernetes版本的詳細(xì)信息，包括Kubernetes版本信息、版本的發(fā)布日期和過期時間、兼容的操作系統(tǒng)，使用的運行時等。 |
| DescribeUserClusterNamespaces | 查詢RAM用戶或角色可見的集群命名空間 | 在ACK集群中，可以通過Kubernetes命名空間對集群訪問者進(jìn)行權(quán)限和資源的邏輯隔離，只被授予指定命名空間下RBAC權(quán)限的用戶將無法訪問集群其他命名空間內(nèi)的資源。您可以調(diào)用DescribeUserClusterNamespaces接口，查看當(dāng)前RAM用戶或角色在指定的ACK集群內(nèi)被授予了哪些命名空間內(nèi)資源的RBAC訪問權(quán)限。 |
| DescribeClusterLogs | 查詢集群日志 | 您可以調(diào)用DescribeClusterLogs接口檢索集群的日志數(shù)據(jù)，以便在出現(xiàn)集群問題時進(jìn)行根因分析和溯源。 |
| RunClusterCheck | 發(fā)起集群檢查 | 容器智能運維平臺提供豐富的Kubernetes集群檢查能力，包括集群升級檢查、集群遷移檢查、組件安裝檢查、組件升級檢查、節(jié)點池檢查等。在正式執(zhí)行升級、遷移或安裝操作前，容器智能運維平臺會自動觸發(fā)檢查，僅當(dāng)檢查通過后您才可以執(zhí)行變更操作。您也可以手動調(diào)用RunClusterCheck接口執(zhí)行集群檢查。建議您定期對集群進(jìn)行檢查和維護(hù)，預(yù)防集群安全風(fēng)險。 |
| ListClusterChecks | 查詢所有集群檢查的列表 | 容器智能運維平臺提供豐富的Kubernetes集群檢查能力，包括集群升級檢查、集群遷移檢查、組件安裝檢查、組件升級檢查、節(jié)點池檢查等。您可以調(diào)用ListClusterChecks接口，根據(jù)集群ID查詢集群檢查的列表和檢查相關(guān)信息，例如檢查類型、狀態(tài)、創(chuàng)建和完成時間等。 |
| GetClusterCheck | 查詢指定集群檢查的信息 | 容器智能運維平臺提供豐富的Kubernetes集群檢查能力，包括集群升級檢查、集群遷移檢查、組件安裝檢查、組件升級檢查、節(jié)點池檢查等。您可以調(diào)用GetClusterCheck接口，根據(jù)集群ID和檢查任務(wù)ID查看指定檢查任務(wù)的相關(guān)信息，例如檢查狀態(tài)、具體檢查項、檢查創(chuàng)建和完成時間等。 |
| CreateClusterDiagnosis | 發(fā)起集群診斷 | 發(fā)起集群診斷。 |
| GetClusterDiagnosisResult | 查詢集群診斷結(jié)果 | 獲取集群診斷結(jié)果。 |
| GetClusterDiagnosisCheckItems | 查詢集群診斷檢查項 | 獲取集群診斷檢查項。 |
| ModifyCluster | 修改集群配置 | 創(chuàng)建ACK集群后，如需修改集群的配置，您可以調(diào)用ModifyCluster接口來完成。 |
| MigrateCluster | 遷移基礎(chǔ)版集群至Pro版 | ACK集群Pro版是在ACK集群基礎(chǔ)版的基礎(chǔ)上發(fā)展而來的集群類型，繼承了原托管版集群的所有優(yōu)勢，例如控制面托管、控制面高可用等。同時，ACK集群Pro版進(jìn)一步增強了集群的可靠性、安全性和調(diào)度性，并且支持賠付標(biāo)準(zhǔn)的SLA，適合生產(chǎn)環(huán)境下有著大規(guī)模業(yè)務(wù)，對穩(wěn)定性和安全性有高要求的企業(yè)客戶。建議您將ACK集群基礎(chǔ)版遷移至ACK集群Pro版。 |
| DescribeClusterUserKubeconfig | 查詢集群KubeConfig | KubeConfig用于在客戶端配置ACK集群的訪問憑據(jù)，包含訪問目標(biāo)集群的身份和認(rèn)證數(shù)據(jù)等信息。使用kubectl管理集群時，您需要通過KubeConfig來連接。請妥善管理集群的KubeConfig憑據(jù)，并在無需使用憑據(jù)時及時完成吊銷，避免KubeConfig泄露帶來的數(shù)據(jù)泄露等安全風(fēng)險。 |
| DescribeSubaccountK8sClusterUserConfig | 使用阿里云賬號獲取指定RAM用戶或角色的集群KubeConfig | 作為集群權(quán)限管理者，您可以使用阿里云賬號（主賬號）為賬號內(nèi)指定RAM用戶或RAM角色簽發(fā)包含其身份信息的KubeConfig憑證，用于連接ACK集群。您可以調(diào)用DescribeSubaccountK8sClusterUserConfig接口，簽發(fā)或獲取賬號內(nèi)任意RAM用戶或角色的KubeConfig。 |
| UpdateK8sClusterUserConfigExpire | 更新用戶自定義配置的過期時間 | ACK集群下發(fā)的KubeConfig過期時間默認(rèn)為3年。您可以使用阿里云賬號（主賬號）自定義配置，調(diào)用UpdateK8sClusterUserConfigExpire接口指定RAM用戶或角色在ACK集群中下發(fā)的KubeConfig的過期時間（1～876000小時）。 |
| ScanClusterVuls | 掃描集群安全漏洞 | 您可以調(diào)用ScanClusterVuls接口掃描ACK集群中潛在的安全漏洞，包括容器工作負(fù)載漏洞、三方軟件漏洞、CVE漏洞、WebCMS漏洞、Windows操作系統(tǒng)漏洞等。建議您定期掃描集群的安全漏洞，提高集群安全性。 |
| DescribeClusterVuls | 查詢集群安全漏洞信息 | 您可以根據(jù)集群ID調(diào)用DescribeClusterVuls接口查看集群的安全漏洞詳細(xì)信息，包括漏洞名稱、漏洞類型、漏洞等級等。建議您定期掃描集群的安全漏洞，提高集群安全性。 |
節(jié)點池
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateClusterNodePool | 創(chuàng)建節(jié)點池 | 通過節(jié)點池，您可以更方便地對節(jié)點進(jìn)行分組管理，例如節(jié)點運維、節(jié)點配置、開啟節(jié)點自動彈性伸縮、批量管理、指定調(diào)度等。您可以調(diào)用CreateClusterNodePool為集群創(chuàng)建節(jié)點池。推薦您使用托管節(jié)點池，以幫助您自動完成部分節(jié)點運維操作，例如高危CVE漏洞自動修復(fù)、部分故障修復(fù)等，從而降低您的節(jié)點運維負(fù)擔(dān)。 |
| DeleteClusterNodepool | 刪除節(jié)點池 | 您可以調(diào)用DeleteClusterNodepool接口刪除不再使用的節(jié)點池。 |
| DescribeClusterNodePoolDetail | 查詢節(jié)點池配置 | 您可以根據(jù)節(jié)點池ID，調(diào)用DescribeClusterNodePoolDetail接口查詢集群中目標(biāo)節(jié)點池的配置。 |
| DescribeClusterNodePools | 查詢節(jié)點池列表 | 查詢集群內(nèi)所有節(jié)點池列表。 |
| DescribeNodePoolVuls | 查詢節(jié)點池漏洞 | 您可以根據(jù)節(jié)點池ID調(diào)用DescribeNodePoolVuls接口查看節(jié)點池的安全漏洞詳細(xì)信息，包括漏洞名稱、漏洞等級等。建議您定期掃描節(jié)點池的安全漏洞，提高集群安全性。 |
| ModifyClusterNodePool | 修改節(jié)點池配置 | 您可以根據(jù)節(jié)點池ID，調(diào)用ModifyClusterNodePool接口更新目標(biāo)節(jié)點池的配置。 |
| ScaleClusterNodePool | 擴容節(jié)點池 | 您可以調(diào)用ScaleClusterNodePool對節(jié)點進(jìn)行擴容，以保證節(jié)點數(shù)量足夠支撐業(yè)務(wù)運行。 |
| AttachInstancesToNodePool | 添加已有節(jié)點到節(jié)點池 | 如果需要將已有ECS實例添加到ACK集群中作為Worker節(jié)點，或移除Worker節(jié)點后需將節(jié)點實例重新加入節(jié)點池，您可以調(diào)用AttachInstancesToNodePool將已有節(jié)點添加到節(jié)點池。 |
| RemoveNodePoolNodes | 移除節(jié)點池節(jié)點 | 當(dāng)您不再需要集群節(jié)點繼續(xù)工作時，可以調(diào)用RemoveNodePoolNodes接口將集群中的節(jié)點移出節(jié)點池，并同時調(diào)整期望節(jié)點數(shù)。移除節(jié)點時，您可以選擇是否同時釋放ECS、是否自動排空節(jié)點。移除節(jié)點會涉及Pod遷移，可能會影響業(yè)務(wù)，請在業(yè)務(wù)低峰期操作并提前做好相關(guān)的數(shù)據(jù)備份。 |
| UpgradeClusterNodepool | 升級節(jié)點池 | 您可以調(diào)用UpgradeClusterNodepool接口升級指定集群節(jié)點池的kubelet版本（建議與控制面版本一致）、操作系統(tǒng)版本或容器運行時版本。 |
| RepairClusterNodePool | 修復(fù)節(jié)點池節(jié)點 | 修復(fù)集群節(jié)點池。 |
| FixNodePoolVuls | 修復(fù)節(jié)點池漏洞 | 阿里云云安全產(chǎn)品會定期掃描ECS節(jié)點上的安全漏洞，并提供對應(yīng)的修復(fù)建議與方法。某些CVE的修復(fù)可能需要重啟節(jié)點，請確保集群有充足的節(jié)點用于排水操作。您可以調(diào)用FixNodePoolVuls接口修復(fù)指定集群節(jié)點池的節(jié)點漏洞，提高集群節(jié)點的安全性。 |
| ModifyNodePoolNodeConfig | 修改節(jié)點池節(jié)點配置 | 您可以調(diào)用ModifyNodePoolNodeConfig接口修改集群節(jié)點池中節(jié)點配置信息，例如kubelet配置、節(jié)點輪轉(zhuǎn)配置等。修改節(jié)點配置會按批次變更節(jié)點配置并重啟kubelet, 可能會對節(jié)點運行和工作負(fù)載運行產(chǎn)生一定影響，請在業(yè)務(wù)低峰期操作。 |
| SyncClusterNodePool | 同步節(jié)點池 | 您可以調(diào)用SyncClusterNodePool接口同步集群節(jié)點池，包含節(jié)點池元數(shù)據(jù)、節(jié)點池內(nèi)節(jié)點信息等。 |
| DescribeClusterAttachScripts | 查詢添加已有節(jié)點到集群節(jié)點池的腳本 | 如果需要將已有ECS實例添加到ACK集群中作為Worker節(jié)點，或移除Worker節(jié)點后需將節(jié)點實例重新加入節(jié)點池，ACK支持手動將已有節(jié)點到節(jié)點池。您可以調(diào)用DescribeClusterAttachScripts接口獲取添加已有節(jié)點的腳本。 |
| CreateAutoscalingConfig | 創(chuàng)建彈性伸縮配置 | 您可以創(chuàng)建自動彈性伸縮配置，讓系統(tǒng)能夠按照配置的伸縮規(guī)則自動增加或減少計算資源，滿足您的集群工作負(fù)載的需求。創(chuàng)建過程中，您可以指定擴縮容的度量指標(biāo)和閾值、擴容順序、靜默時間等。 |
節(jié)點
| API | 標(biāo)題 | API概述 |
|---|---|---|
| DescribeClusterNodes | 查詢集群節(jié)點列表 | 您可以調(diào)用DescribeClusterNodes接口，查詢符合條件的節(jié)點列表信息。 |
| DeleteClusterNodes | 移除集群節(jié)點 | 當(dāng)您不再需要集群節(jié)點繼續(xù)工作時，可以調(diào)用DeleteClusterNodes接口將集群中的節(jié)點移出集群。移除節(jié)點時，您可以選擇是否同時釋放ECS、是否自動排空節(jié)點。移除節(jié)點會涉及Pod遷移，可能會影響業(yè)務(wù)，請在業(yè)務(wù)低峰期操作并提前做好相關(guān)的數(shù)據(jù)備份。 |
組件
| API | 標(biāo)題 | API概述 |
|---|---|---|
| InstallClusterAddons | 安裝集群組件 | 為了增強Kubernetes能力，ACK集群支持了多種組件，例如托管的核心組件，應(yīng)用、日志和監(jiān)控、網(wǎng)絡(luò)、存儲、安全組件等。您可以調(diào)用InstallClusterAddons接口，通過組件名稱和版本安裝組件。 |
| UnInstallClusterAddons | 卸載集群組件 | 當(dāng)您無需使用集群某些組件時，您可以調(diào)用UnInstallClusterAddons接口指定組件名稱，刪除組件，并選擇是否刪除關(guān)聯(lián)的阿里云云資源。 |
| DescribeAddons | 查詢集群組件詳情 | 查詢平臺支持的所有組件的詳情。 |
| DescribeClusterAddonsVersion | 查詢集群組件版本 | 根據(jù)集群ID，查詢集群中已安裝的所有組件的詳情。 |
| DescribeClusterAddonInstance | 查詢集群組件實例信息 | 調(diào)用DescribeClusterAddonInstance查詢已安裝的集群組件的版本、狀態(tài)和配置等信息。 |
| ListAddons | 查詢可用的組件列表 | 您可以調(diào)用ListAddons接口，根據(jù)指定地域、集群類型、集群子類型（profile）、集群版本等參數(shù)獲取可用組件的列表，并查詢組件的詳細(xì)信息，包括組件托管與否、支持的自定義參數(shù)Schema、兼容的操作系統(tǒng)架構(gòu)等。 |
| ListClusterAddonInstances | 查詢集群已安裝的組件實例列表 | 您可以調(diào)用ListClusterAddonInstances接口獲取目標(biāo)集群已安裝的組件實例列表并查詢組件實例的相關(guān)信息，包括組件版本、狀態(tài)等。 |
| GetClusterAddonInstance | 查詢集群內(nèi)指定組件實例信息 | 您可以調(diào)用GetClusterAddonInstance接口查詢集群中目標(biāo)組件的詳細(xì)信息，包括目標(biāo)組件實例的版本、參數(shù)配置、日志功能啟用狀態(tài)等。 |
| DescribeAddon | 查詢指定組件的信息 | 您可以調(diào)用DescribeAddon接口，根據(jù)指定地域、集群類型、集群子類型（profile）、集群版本、組件名稱等參數(shù)查詢目標(biāo)組件的信息，包括組件托管與否、組件分類、支持的自定義參數(shù)Schema、兼容的操作系統(tǒng)架構(gòu)、該版本要求的最低集群版本等。 |
| ModifyClusterAddon | 修改集群組件實例配置 | 您可以調(diào)用ModifyClusterAddon配置修改已安裝的集群組件實例的配置。修改配置可能會影響業(yè)務(wù)，請評估影響后在業(yè)務(wù)低峰期操作并提前做好相關(guān)的數(shù)據(jù)備份。 |
| DescribeClusterAddonMetadata | 查詢集群組件元數(shù)據(jù) | 調(diào)用DescribeClusterAddonMetadata查詢特定集群可使用的指定組件版本信息，包括組件版本、可配置參數(shù)等。 |
| UpgradeClusterAddons | 升級集群實例組件 | 您可以調(diào)用UpgradeClusterAddons接口升級集群組件實例的版本，從而享受新版本帶來的功能優(yōu)化、缺陷修復(fù)等。請依次逐個組件升級，確認(rèn)一個組件升級成功后再升級下一個組件。升級組件前，請了解每個組件升級的注意事項。升級集群組件實例版本可能會影響業(yè)務(wù)，請評估影響后在業(yè)務(wù)低峰期操作并提前做好相關(guān)的數(shù)據(jù)備份。 |
| DescribeClusterAddonsUpgradeStatus | 查詢集群組件升級狀態(tài) | 根據(jù)組件名稱查詢該組件升級狀態(tài)。 |
升級
| API | 標(biāo)題 | API概述 |
|---|---|---|
| UpgradeCluster | 升級集群 | 為避免過期版本集群潛在的安全和穩(wěn)定性風(fēng)險，同時享用新集群版本的新功能，請隨ACK集群的版本發(fā)布節(jié)奏升級集群。升級集群前，請參考Kubernetes版本說明幫助文檔了解待升級版本的版本解讀、廢棄資源API、升級注意事項等，避免因高版本的功能變更導(dǎo)致業(yè)務(wù)功能不兼容，繼而影響集群正常運行。升級集群前請先進(jìn)行集群升級檢查。升級集群版本可能會影響業(yè)務(wù)，請評估影響后在業(yè)務(wù)低峰期操作并提前做好相關(guān)的數(shù)據(jù)備份。 |
| GetUpgradeStatus | 查詢集群升級狀態(tài) | 根據(jù)集群ID，查詢該集群的升級狀態(tài)。 |
| PauseClusterUpgrade | 暫停集群升級 | 暫停用戶集群升級。 |
| CancelClusterUpgrade | 取消集群升級 | 取消處于升級狀態(tài)的ACK集群。 |
| ResumeUpgradeCluster | 重新開始集群升級 | 根據(jù)集群ID，恢復(fù)升級處于升級暫停狀態(tài)的集群。 |
權(quán)限
| API | 標(biāo)題 | API概述 |
|---|---|---|
| DescribeUserPermission | 查詢RAM用戶或角色的集群授權(quán)信息 | 在ACK集群中，您可以創(chuàng)建并指定不同RAM用戶或角色擁有不同的訪問權(quán)限，從而確保安全訪問控制和資源隔離。您可以調(diào)用DescribeUserPermission接口查詢RAM用戶或角色擁有的集群權(quán)限詳情，包括可訪問的資源、權(quán)限的作用范圍、預(yù)置的角色類型、權(quán)限來源等。 |
| GrantPermissions | 全量更新RAM用戶或角色的集群授權(quán)信息 | 在ACK集群中，非集群創(chuàng)建者或阿里云賬號（主賬號）在集群中默認(rèn)沒有任何RBAC權(quán)限。您可以調(diào)用GrantPermissions接口，更新RAM用戶或角色擁有的RBAC訪問權(quán)限，包括可訪問的資源、權(quán)限的作用范圍、預(yù)置的角色類型等，從而更好地管理集群的安全訪問控制。 |
| UpdateUserPermissions | 更新指定RAM用戶/角色的RBAC權(quán)限 | 在ACK集群中，非集群創(chuàng)建者或阿里云賬號（主賬號）在集群中默認(rèn)沒有任何RBAC權(quán)限。您可以調(diào)用UpdateUserPermissions接口，更新RAM用戶或角色擁有的RBAC訪問權(quán)限，包括可訪問的資源、權(quán)限的作用范圍、預(yù)置的角色類型等，從而更好地管理集群的安全訪問控制。 |
編排模版
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateTemplate | 創(chuàng)建編排模板 | 編排模板是對一組Kubernetes集群資源的定義和描述，以聲明性方式描述應(yīng)用應(yīng)該如何運行或者配置。您可以基于這些模板自動化部署和管理集群中的資源，例如Pods、Services、Deployments、ConfigMaps、PersistentVolumes等。您可以調(diào)用CreateTemplate接口創(chuàng)建一個編排模板。 |
| DescribeTemplateAttribute | 查詢指定編排模板的詳情 | 編排模板是對一組Kubernetes集群資源的定義和描述，以聲明性方式描述應(yīng)用應(yīng)該如何運行或者配置。您可以調(diào)用DescribeTemplateAttribute接口，查詢目標(biāo)編排模板的詳細(xì)信息，包括訪問權(quán)限、YAML內(nèi)容、標(biāo)簽等。 |
| DescribeTemplates | 查詢所有編排模板 | 編排模板是對一組Kubernetes集群資源的定義和描述，以聲明性方式描述應(yīng)用應(yīng)該如何運行或者配置。您可以調(diào)用DescribeTemplates接口獲取已創(chuàng)建的編排模板的列表，并查詢編排模板的詳細(xì)信息，包括訪問權(quán)限、YAML內(nèi)容、標(biāo)簽等。 |
| UpdateTemplate | 更新編排模板 | 編排模板是對一組Kubernetes集群資源的定義和描述，以聲明性方式描述應(yīng)用應(yīng)該如何運行或者配置。您可以調(diào)用UpdateTemplate接口更新編排模板配置。 |
| DeleteTemplate | 刪除編排模板 | 當(dāng)您無需使用某些編排模板時，您可以調(diào)用DeleteTemplate接口刪除編排模板。 |
觸發(fā)器
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateTrigger | 創(chuàng)建觸發(fā)器 | 您可以為集群應(yīng)用配置觸發(fā)器的功能，指定觸發(fā)器在接收到某些條件時重新部署Pod。 |
| DeleteTrigger | 刪除觸發(fā)器 | 當(dāng)您不再需要觸發(fā)器時，可以調(diào)用DeleteTrigger刪除應(yīng)用觸發(fā)器。 |
| DescribeTrigger | 查詢觸發(fā)器 | 您可以調(diào)用DescribeTrigger接口，查詢符合條件的觸發(fā)器。 |
標(biāo)簽
| API | 標(biāo)題 | API概述 |
|---|---|---|
| ListTagResources | 查詢集群的標(biāo)簽列表 | 您可以為集群添加標(biāo)簽鍵值對，讓集群開發(fā)或運維人員能夠更靈活地對集群進(jìn)行分類管理，更好的支持監(jiān)控、成本分析、租戶隔離等需求。您可以調(diào)用ListTagResources接口，獲取資源標(biāo)簽的列表并查詢標(biāo)簽的詳細(xì)信息，例如鍵值對、綁定的集群等。 |
| TagResources | 為集群綁定標(biāo)簽 | 您可以為集群添加標(biāo)簽鍵值對，讓集群開發(fā)或運維人員能夠更靈活地對集群進(jìn)行分類管理，更好的支持監(jiān)控、成本分析、租戶隔離等需求。您可以調(diào)用TagResources接口，為集群綁定標(biāo)簽。 |
| UntagResources | 刪除集群標(biāo)簽 | 當(dāng)您無需使用集群的標(biāo)簽鍵值對時，您可以調(diào)用UntagResources接口，刪除資源標(biāo)簽。 |
| ModifyClusterTags | 全量更新集群標(biāo)簽 | 您可以為集群添加標(biāo)簽鍵值對，讓集群開發(fā)或運維人員能夠更靈活地對集群進(jìn)行分類管理，更好的支持監(jiān)控、成本分析、租戶隔離等需求。您可以調(diào)用ModifyClusterTags接口，修改集群標(biāo)簽。 |
日志
| API | 標(biāo)題 | API概述 |
|---|---|---|
| UpdateControlPlaneLog | 修改ACK托管集群控制面組件日志配置 | ACK托管集群支持收集控制面組件日志并投遞到您的SLS Log Project中。控制面組件包括Kube API Server、Kube Scheduler、Kube Controller Manager、Cloud Controller Manager等核心組件。您可以調(diào)用UpdateControlPlaneLog接口，修改控制面組件日志配置，例如日志保存時間、采集的組件等。 |
| CheckControlPlaneLogEnable | 查詢ACK托管集群控制面組件日志配置 | ACK托管集群支持收集控制面組件日志并投遞到您的SLS Log Project中。控制面組件包括Kube API Server、Kube Scheduler、Kube Controller Manager、Cloud Controller Manager等核心組件。您可以調(diào)用CheckControlPlaneLogEnable接口，查詢控制面組件當(dāng)前的日志配置，包括日志保存時間、采集的組件等。 |
| UpdateClusterAuditLogConfig | 更新集群審計日志配置 | 當(dāng)您需要記錄對Kubernetes API的請求以及請求結(jié)果來用于追溯集群操作歷史、排查集群故障時，您可以調(diào)用UpdateClusterAuditLogConfig接口來開啟、關(guān)閉指定ACK集群的審計日志功能、更新審計日志配置。 |
事件
| API | 標(biāo)題 | API概述 |
|---|---|---|
| DescribeEventsForRegion | 查詢指定地域的事件列表 | 查詢指定地域內(nèi)全部事件列表。 |
| DescribeEvents | 查詢事件詳情 | 集群操作事件包括集群創(chuàng)建、集群變更、節(jié)點池創(chuàng)建、節(jié)點池擴容、Addon安裝、集群升級等。您可以調(diào)用DescribeEvents接口，查詢某類事件的詳細(xì)信息，包括事件級別、時間狀態(tài)、事件發(fā)生時間等。 |
| DescribeClusterEvents | 查詢指定集群的事件 | 集群操作事件包括集群創(chuàng)建、集群變更、節(jié)點池創(chuàng)建、節(jié)點池擴容、Addon安裝、集群升級等。您可以調(diào)用DescribeClusterEvents接口，獲取指定集群中發(fā)生的事件列表，并查詢事件的詳細(xì)信息，包括事件級別、時間狀態(tài)、時間發(fā)生時間等。 |
任務(wù)
| API | 標(biāo)題 | API概述 |
|---|---|---|
| DescribeTaskInfo | 查詢?nèi)蝿?wù)詳情 | 您可以調(diào)用DescribeTaskInfo接口，查詢集群任務(wù)的詳細(xì)信息，例如任務(wù)類型、運行狀態(tài)、運行階段等。 |
| PauseTask | 暫停任務(wù) | 您可以調(diào)用PauseTask接口，暫停執(zhí)行中的集群任務(wù)。 |
| ResumeTask | 恢復(fù)任務(wù) | 您可以調(diào)用ResumeTask接口，恢復(fù)已暫停的集群任務(wù)。 |
| CancelTask | 取消任務(wù) | 您可以調(diào)用CancelTask接口，取消集群任務(wù)的執(zhí)行。 |
| DescribeClusterTasks | 查詢集群任務(wù)列表 | 您可以調(diào)用DescribeClusterTasks接口，查詢集群下的任務(wù)列表。 |
策略治理
| API | 標(biāo)題 | API概述 |
|---|---|---|
| DeletePolicyInstance | 刪除策略規(guī)則實例 | 您可以調(diào)用DeletePolicyInstance接口，在指定集群中刪除策略規(guī)則實例。 |
| ModifyPolicyInstance | 更新策略規(guī)則實例 | 您可以調(diào)用ModifyPolicyInstance接口，在指定集群中更新策略規(guī)則實例，調(diào)整策略實例的治理動作（告警或攔截）、作用的命名空間范圍等。 |
| DescribePolicies | 查詢策略治理規(guī)則庫列表 | ACK集群容器安全策略供了種類豐富的內(nèi)置規(guī)則庫，包括Compliance、Infra、K8s-general和PSP，旨在確保容器在生產(chǎn)環(huán)境中的安全運行。您可以調(diào)用DescribePolicies接口，查詢策略治理規(guī)則庫的列表。 |
| DescribePolicyDetails | 查詢指定策略治理規(guī)則的詳情 | ACK集群容器安全策略供了種類豐富的內(nèi)置規(guī)則庫，包括Compliance、Infra、K8s-general和PSP，旨在確保容器在生產(chǎn)環(huán)境中的安全運行。您可以調(diào)用DescribePolicyDetails接口，查詢指定策略治理規(guī)則的詳細(xì)信息，例如規(guī)則模板描述、規(guī)則治理動作、規(guī)則治理等級等。 |
| DescribePolicyGovernanceInCluster | 獲取集群策略治理詳情 | ACK集群容器安全策略供了種類豐富的內(nèi)置規(guī)則庫，包括Compliance、Infra、K8s-general和PSP，旨在確保容器在生產(chǎn)環(huán)境中的安全運行。您可以調(diào)用DescribePolicyGovernanceInCluster接口，查詢目標(biāo)集群策略治理的詳細(xì)信息，例如集群當(dāng)前啟用的不同等級策略計數(shù)統(tǒng)計、策略治理審計日志、攔截和告警情況等。 |
| DescribePolicyInstances | 查詢策略實例列表 | 您可以在ACK集群中選擇安全策略類型，配置相關(guān)實施動作、作用范圍等，創(chuàng)建并部署一個策略實例。您可以調(diào)用DescribePolicyInstances接口，獲取集群中指定策略規(guī)則實例的詳細(xì)信息，例如策略描述、治理等級等。 |
| DescribePolicyInstancesStatus | 查看策略規(guī)則對應(yīng)的實例部署詳情 | 您可以調(diào)用DescribePolicyInstancesStatus接口，查詢集群當(dāng)前不同策略類型對應(yīng)的實例部署狀態(tài)，包括每種策略規(guī)則對應(yīng)開啟的實例計數(shù)，以及不同治理等級下開啟的策略種類計數(shù)。 |
| DeployPolicyInstance | 部署策略規(guī)則實例 | 您可以在ACK集群中選擇安全策略類型，配置策略實例的治理動作（告警或攔截）、作用的命名空間范圍等，以創(chuàng)建并部署一個策略實例。您可以調(diào)用DeployPolicyInstance接口，在指定集群的命名空間中部署策略規(guī)則實例。 |
其他
| API | 標(biāo)題 | API概述 |
|---|---|---|
| DescribeUserQuota | 查詢集群配額 | 您可以調(diào)用DescribeUserQuota接口，查詢ACK集群、節(jié)點池、節(jié)點的相關(guān)配額。如需擴大配額，請前往配額中心申請。 |
| ListOperationPlans | 查詢自動運維任務(wù)執(zhí)行計劃列表 | 獲取自動運維執(zhí)行計劃列表。 |
| CancelOperationPlan | 取消自動運維任務(wù)執(zhí)行計劃 | 使用CancelOperationPlan取消已存在但未執(zhí)行的自動運維任務(wù)執(zhí)行計劃。 |