DescribeClusterAddonInstance - Container Service for Kubernetes

This API is deprecated. You are advised to use CS(2015-12-15) - GetClusterAddonInstance.

You can call the DescribeClusterAddonInstance operation to query the information about a cluster component, including the version, status, and configuration of the component.

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:DescribeClusterAddonInstance	get	Cluster acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}	none	none

Request syntax

GET /clusters/{ClusterID}/components/{AddonName}/instance HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ClusterID	string	Yes	The ID of the cluster.	cd06bbf8a86764a31bcac76136691****
AddonName	string	Yes	The name of the component.	terway-eniip

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
name	string	The name of the component.	terway-eniip
version	string	The version of the component.	v1.4.3
state	string	The status of the component. Valid values: initial: The component is being installed. active: The component is installed. unhealthy: The component is in an abnormal state. upgrading: The component is being updated. updating: The component is being modified. deleting: The component is being uninstalled. deleted: The component is deleted.	active
config	string	The configuration of the component.	{"NetworkPolicy":"true"}

Examples

Sample success responses

JSONformat

{
  "name": "terway-eniip",
  "version": "v1.4.3",
  "state": "active",
  "config": "{\"NetworkPolicy\":\"true\"}"
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-09-23	The internal configuration of the API is changed, but the call is not affected	View Change Details
2024-01-12	The API operation is deprecated	View Change Details
2023-04-17	The internal configuration of the API is changed, but the call is not affected	View Change Details