DescribeClusterUserKubeconfig - 查詢叢集KubeConfig - Container Service for Kubernetes

KubeConfig用於在用戶端配置ACK叢集的訪問憑據，包含訪問目的地組群的身份和認證資料等資訊。使用kubectl管理叢集時，需要先通過KubeConfig來串連叢集，您可以調用DescribeClusterUserKubeconfig介面查詢指定叢集的KubeConfig。

介面說明

KubeConfig 簽發認證的預設有效期間為 3 年。在臨近到期 180 天內，您可以通過Container Service管理主控台或擷取叢集 KubeConfig 介面擷取輪轉後重新整理的 KubeConfig，新 KubeConfig 認證的有效期間仍為 3 年，老的 KubeConfig 憑據在認證到期前仍然有效，請您根據控制台顯示或介面返回的 KubeConfig 到期時間及時擷取輪轉憑據。
請妥善管理叢集的 KubeConfig 憑據，並在無需使用憑據時及時完成吊銷，避免 KubeConfig 泄露帶來的資料泄露等安全風險。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

cs:DescribeClusterUserKubeconfig

get

*Cluster

acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}

cs:KubeConfigDurationMinutes

無

請求文法

GET /k8s/{ClusterId}/user_config HTTP/1.1

路徑參數

名稱	類型	必填	描述	樣本值
ClusterId	string	是	叢集 ID。	c5b5e80b0b64a4bf6939d2d8fbbc5****

請求參數

名稱	類型	必填	描述	樣本值
PrivateIpAddress	boolean	否	是否擷取內網串連配置。取值： `true`：僅擷取內網串連憑據。 `false`：僅擷取公網串連憑據。預設值：`false`。	false
TemporaryDurationMinutes	integer	否	臨時 KubeConfig 有效期間，單位：分鐘。取值範圍：15（15 分鐘）～4320（3 天）。說明當不設定該參數時，將由系統自動確定一個更長的有效期間，具體到期時間通過返回的`expiration`欄位的值確定。	15

返回參數

名稱	類型	描述	樣本值
	object	返回資料體。
config	string	叢集的 KubeConfig。	apiVersion: v1\nclusters:\n- cluster:\n server: https://114.55.xx.xx:6443\n certificate-authority-data: LS0tLS****
expiration	string	KubeConfig 的到期時間。格式：RFC3339 格式的 UTC 時間。	2024-03-10T09:56:17Z

樣本

正常返回樣本

JSON格式

{
  "config": "apiVersion: v1\\nclusters:\\n- cluster:\\n    server: https://114.55.xx.xx:6443\\n    certificate-authority-data: LS0tLS****",
  "expiration": "2024-03-10T09:56:17Z"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。