DescribeClusterResources - Container Service for Kubernetes

You can call the DescribeClusterResources operation to query all resources in a cluster by cluster ID.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
cs:DescribeClusterResources	get	*Cluster `acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}`	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The cluster ID. For more information about how to query cluster IDs, see View cluster information. You can also call the DescribeClustersV1 API operation to query all clusters that belong to an Alibaba Cloud account.	cb95aa626a47740afbf6aa099b65****
with_addon_resources	boolean	No	Specifies whether to query the resources created by cluster components.

Response parameters

Parameter	Type	Description	Example
	array<object>	The resources in the cluster.
	object	The details of the resource.
cluster_id	string	The cluster ID.	cb95aa626a47740afbf6aa099b65****
created	string	The time when the resource was created.	2020-09-11T10:11:54+08:00
instance_id	string	The resource ID.	lb-wz9poz4r0ymh8u0uf****
resource_info	string	The resource information. For more information about how to query the source information about the resource, see ListStackResources .	{\"Id\":\"k8s_master_slb\",\"Name\":\"k8s_master_slb\",\"Type\":\"ALIYUN::SLB::LoadBalancer\",\"Status\":\"CREATE_COMPLETE\",\"StatusReason\":\"state changed\",\"Updated\":\"2020-05-21T13:25:02\",\"PhysicalId\":\"lb-wz9poz4r0ymh8u0uf****\"}
resource_type	string	The resource type.	ALIYUN::SLB::LoadBalancer
state	string	The resource status. Valid values: `CREATE_COMPLETE`: the resource is created. `CREATE_FAILED`: the resource failed to be created. `CREATE_IN_PROGRESS`: the resource is being created. `DELETE_FAILED`: the resource failed to be deleted. `DELETE_IN_PROGRESS`: the resource is being deleted. `ROLLBACK_COMPLETE`: the resource is rolled back. `ROLLBACK_FAILED`: the resource failed to be rolled back. `ROLLBACK_IN_PROGRESS`: the resource is being rolled back.	CREATE_COMPLETE
auto_create	long	Specifies whether the resource is created by Container Service for Kubernetes (ACK). Valid values: 1: the resource is created by ACK. 0: the resource is an existing resource.	1
dependencies	object	The dependent resources.
associated_object	object	The Kubernetes object with which the resource is associated.
kind	string	The Kubernetes object type.	Service
namespace	string	The namespace in which the Kubernetes object resides.	kube-system
name	string	The Kubernetes object name.	nginx-ingress-lb
delete_behavior	object	The deletion behavior of the resource when the cluster is deleted.
delete_by_default	boolean	Specifies whether to delete the resource by default when the cluster is deleted.	false
changeable	boolean	Specifies whether the default behavior returned in delete_by_default can be changed.	false
creator_type	string	The resource creator. Valid values: user: The resource is created by the user. system: The resource is created by the ACK management system. addon: The resource is created by a cluster component.	addon
extra_info	object	The additional information about the resource.	{"IP": "xx.xx.xx.xx"}

Examples

Sample success responses

JSONformat

[
  {
    "cluster_id": "cb95aa626a47740afbf6aa099b65****",
    "created": "2020-09-11T10:11:54+08:00",
    "instance_id": "lb-wz9poz4r0ymh8u0uf****",
    "resource_info": "{\\\"Id\\\":\\\"k8s_master_slb\\\",\\\"Name\\\":\\\"k8s_master_slb\\\",\\\"Type\\\":\\\"ALIYUN::SLB::LoadBalancer\\\",\\\"Status\\\":\\\"CREATE_COMPLETE\\\",\\\"StatusReason\\\":\\\"state changed\\\",\\\"Updated\\\":\\\"2020-05-21T13:25:02\\\",\\\"PhysicalId\\\":\\\"lb-wz9poz4r0ymh8u0uf****\\\"}",
    "resource_type": "ALIYUN::SLB::LoadBalancer",
    "state": "CREATE_COMPLETE",
    "auto_create": 1,
    "dependencies": {
      "test": "test",
      "test2": 1
    },
    "associated_object": {
      "kind": "Service",
      "namespace": "kube-system",
      "name": "nginx-ingress-lb"
    },
    "delete_behavior": {
      "delete_by_default": false,
      "changeable": false
    },
    "creator_type": "addon",
    "extra_info": {
      "IP": "xx.xx.xx.xx"
    }
  }
]

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-03-13	The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2023-10-20	The response structure of the API has changed	View Change Details
2023-10-11	The response structure of the API has changed	View Change Details
2020-09-10	The response structure of the API has changed	View Change Details