DescribeClusterResources - 查詢指定叢集的關聯資源 - Container Service for Kubernetes

您在使用Container Service Kubernetes 版過程中，會同時使用其他關聯的阿里雲雲產品資源。您可以調用DescribeClusterResources介面查詢指定叢集的關聯資源，例如VPC、SLB等。如果您需要查詢節點池或節點資源，您可以調用DescribeClusterNodePools或DescribeClusterNodes介面。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

cs:DescribeClusterResources

get

*Cluster

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

無

請求文法

GET /clusters/{ClusterId}/resources HTTP/1.1

路徑參數

名稱	類型	必填	描述	樣本值
ClusterId	string	是	叢集 ID。關於如何查看叢集 ID，請參見查看叢集資訊。您也可通過 API 介面 DescribeClustersV1 ，查看阿里雲帳號下所有建立的叢集資訊。	cb95aa626a47740afbf6aa099b65****

請求參數

名稱	類型	必填	描述	樣本值
with_addon_resources	boolean	否	是否同時查詢叢集組件建立的資源。 true：查詢。 false：不查詢。	false

返回參數

名稱	類型	描述	樣本值
	array	資來源物件列表。
	array<object>	資源詳情。
cluster_id	string	叢集 ID。	cb95aa626a47740afbf6aa099b65****
created	string	資源建立時間。	2023-08-15T14:34:42+08:00
instance_id	string	資源 ID。	ngw-wz9sphwk42sdtjixo****
resource_info	string	資源資訊。關於資源的源資訊，請參見 ListStackResources 。	{\"Id\":\"KubernetesWorkerRole\",\"Name\":\"KubernetesWorkerRole\",\"Type\":\"ALIYUN::RAM::Role\",\"Status\":\"CREATE_COMPLETE\",\"StatusReason\":\"state changed\",\"Updated\":\"2025-04-10T06:21:17\",\"PhysicalId\":\"KubernetesWorkerRole-7e611193-225f-40f6-bc3c-ea8633******\"}
resource_type	string	資源類型。	ALIYUN::VPC::NatGateway
state	string	資源狀態。可選值： `CREATE_COMPLETE`：成功建立資源。 `CREATE_FAILED`：建立資源失敗。 `CREATE_IN_PROGRESS`：建立資源中。 `DELETE_FAILED`：刪除資源失敗。 `DELETE_IN_PROGRESS`：刪除資源中。 `ROLLBACK_COMPLETE`：成功復原。 `ROLLBACK_FAILED`：復原失敗。 `ROLLBACK_IN_PROGRESS`：復原中。	CREATE_COMPLETE
auto_create	integer	資源是否由 ACK 建立： 1：表示由 ACK 建立。 0：表示該資源為已有資源。	1
dependencies	array<object>	依賴資源清單。
	object	依賴資源詳情。
cluster_id	string	依賴資源的叢集 ID。	cc5ee03f63e43425cb6f71f1a1756****
resource_type	string	依賴資源類型。	ALIYUN::VPC::NatGateway
instance_id	string	依賴資源執行個體 ID。	ngw-wz9sphwk42sdtjixo****
associated_object	object	資源關聯的 k8s 對象。
kind	string	k8s 物件類型。	Service
namespace	string	k8s 對象命名空間。	kube-system
name	string	k8s 對象名稱。	nginx-ingress-lb
delete_behavior	object	刪除叢集時該資源的刪除行為。
delete_by_default	boolean	刪除叢集時是否預設刪除該資源。 true：預設刪除該資源。 fasle：不刪除該資源。	false
changeable	boolean	`delete_by_default`的預設行為是否可以更改。 true：可以更改。 false：不支援更改。	false
creator_type	string	該資源建立者的類型。可能的取值： user：由使用者自行建立； system：由 ACK 管控系統建立； addon：由叢集組件建立。	addon
extra_info	object	資源的其他資訊。	{ "type": "SLS_Data" }

樣本

正常返回樣本

JSON格式

[
  {
    "cluster_id": "cb95aa626a47740afbf6aa099b65****",
    "created": "2023-08-15T14:34:42+08:00",
    "instance_id": "ngw-wz9sphwk42sdtjixo****",
    "resource_info": "{\\\"Id\\\":\\\"KubernetesWorkerRole\\\",\\\"Name\\\":\\\"KubernetesWorkerRole\\\",\\\"Type\\\":\\\"ALIYUN::RAM::Role\\\",\\\"Status\\\":\\\"CREATE_COMPLETE\\\",\\\"StatusReason\\\":\\\"state changed\\\",\\\"Updated\\\":\\\"2025-04-10T06:21:17\\\",\\\"PhysicalId\\\":\\\"KubernetesWorkerRole-7e611193-225f-40f6-bc3c-ea8633******\\\"}",
    "resource_type": "ALIYUN::VPC::NatGateway",
    "state": "CREATE_COMPLETE",
    "auto_create": 1,
    "dependencies": [
      {
        "cluster_id": "cc5ee03f63e43425cb6f71f1a1756****",
        "resource_type": "ALIYUN::VPC::NatGateway",
        "instance_id": "ngw-wz9sphwk42sdtjixo****"
      }
    ],
    "associated_object": {
      "kind": "Service",
      "namespace": "kube-system",
      "name": "nginx-ingress-lb"
    },
    "delete_behavior": {
      "delete_by_default": false,
      "changeable": false
    },
    "creator_type": "addon",
    "extra_info": {
      "type": "SLS_Data"
    }
  }
]

錯誤碼

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

變更歷史

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