DescribeAddons

Description

call DescribeAddons to query the details of components installed in the cluster.

Request Method

POST

Request Path

/apsara/route/CS/DescribeAddons

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
regionId	BODY	string	Yes	No sample value for this parameter.	region id
cluster_type	BODY	string	No	Kubernetes	cluster type, value: Kubernetes:Kubernetes proprietary version ManagedKubernetes: edge managed cluster
region	BODY	string	Yes	cn-beijing	the region ID of the cluster.
version	BODY	string	No	2016-01-01	version of api

Return data

Name	Type	Sample value	Description
StandardComponents	map	No sample value for this parameter.	standard component.
group_name	string	storage	component group name.
name	string	ack-arena	component name.
ComponentGroups	array of componentgroup	No sample value for this parameter.	component grouping list.
description	string	test	component function description.
disabled	boolean	false	whether the default installation is prohibited. in addition to the components required by the cluster, some additional components related to logs or routing (for example, Ingress) will be installed when the cluster is created. if you do not want to install the default installation, you can disable the default installation by setting this field. Value: true: the default installation is prohibited. false: default installation.
items	array of item	No sample value for this parameter.	the name of the component contained in this group.
version	string	0.5.0	component version.
required	string	false	whether it is a necessary component for the cluster. Value: true: required components, components that must be installed when the cluster is created. false: non-essential components, after the cluster is created, it can be installed through component management.

Example

Successful Response example

{
 "StandardComponents":"",
 "group_name":"storage",
 "name":"ack-arena",
 "ComponentGroups":"",
 "description":"test",
 "disabled":"false",
 "items":"",
 "version":"0.5.0",
 "required":"false"
}

Failed Response example

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

}