DescribeClusterAddonsVersion

Description

call DescribeClusterAddonsVersion to query information of all components installed in the specified cluster.

Request Method

POST

Request Path

/apsara/route/CS/DescribeClusterAddonsVersion

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
ClusterId	BODY	string	Yes	c82e6987e2961451182edacd74faf	cluster ID.
regionId	BODY	string	Yes	No sample value for this parameter.	region id
version	BODY	string	No	2016-01-01	version of api

Return data

Name	Type	Sample value	Description
exist	boolean	true	whether the component is installed. Value: true: already installed. false: not installed.
component_name	string	ack-node-problem-detector	component name.
can_upgrade	boolean	false	whether the component can be upgraded. Value: true: components can be upgraded. false: components cannot be upgraded.
ready_to_upgrade	string	false	whether the component meets the upgrade conditions. Value: true: the upgrade condition is met. false: does not meet the upgrade conditions.
message	string	plug-ins for node fault detection and reporting to event center	Additional instructions on whether the component can be upgraded.
version	string	1.2.1	current version of the component.
value	string	npd: Custom monitor definitions to add to Node Problem Detector	user-defined parameter values when the component is installed.
required	boolean	false	whether the component is a required component for the cluster. Value: true: is a required component. false: non-essential components.
next_version	string	1.2.1	next Upgradeable version.
changed	string	false	Whether the component has been updated. Value: true: updated. false: not updated.
policy	string	overwrite	component upgrade policy. overwrite: mandatory overwrite. default value:overwrite.

Example

Successful Response example

{
 "exist":"true",
 "component_name":"ack-node-problem-detector",
 "can_upgrade":"false",
 "ready_to_upgrade":"false",
 "message":"plug-ins for node fault detection and reporting to event center",
 "version":"1.2.1",
 "value":"npd: Custom monitor definitions to add to Node Problem Detector",
 "required":"false",
 "next_version":"1.2.1",
 "changed":"false",
 "policy":"overwrite"
}

Failed Response example

{
 "errorSample":
 {
  "resultCode":-1,
  "resultMsg":"system error",
  "result":null
 }

}