GetClusterAddonInstance - Container Service for Kubernetes

You can call the GetClusterAddonInstance operation to query the information of a component instance in a cluster, including the version, configurations, and log status of the component instance.

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

Request syntax

GET /clusters/{cluster_id}/addon_instances/{instance_name} HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
cluster_id	string	No	The ID of the cluster.	c02b3e03be10643e8a644a843ffcb****
instance_name	string	No	The name of the component instance.	ack-node-problem-detector

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
name	string	The name of the component instance.	ack-node-problem-detector
state	string	The status of the component. Valid values: active: The component is installed. updating: The component is being modified. upgrading: The component is being updated. deleting: The component is being uninstalled.	active
version	string	The version of the component instance.	1.2.16
config	string	The custom configurations of the component.	{"sls_project_name":""}
logging	object	The status of Simple Log Service.
capable	boolean	Indicates whether Simple Log Service is supported by the component.	false
enabled	boolean	Indicates whether Simple Log Service is enabled for the component.	false
log_project	string	The Simple Log Service project that is used to collect logs for the component.	my-log-project
logstore	string	The Simple Log Service Logstore that is used to collect logs for the component.	my-logstore

Examples

Sample success responses

JSONformat

{
  "name": "ack-node-problem-detector",
  "state": "active",
  "version": "1.2.16",
  "config": "{\"sls_project_name\":\"\"}",
  "logging": {
    "capable": false,
    "enabled": false,
    "log_project": "my-log-project",
    "logstore": "my-logstore"
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history