Listing Add-on Instances
Function
This API is used to list all add-on instances in the cluster.
The URL for add-on management is in the format of https://{clusterid}.Endpoint/uri. In the URL, {clusterid} indicates the cluster ID, and uri indicates the resource path, that is, the path for API access.
URI
GET /api/v3/addons
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| cluster_id | Yes | String | Cluster ID. For details about how to obtain the cluster ID, see How to Obtain Parameters in the API URI. |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| Content-Type | Yes | String | Message body type (format). Default: application/json |
| X-Auth-Token | Yes | String | Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details about how to obtain a token, see Authentication. Maximum: 16384 |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| kind | String | API type. The value is fixed at Addon and cannot be changed. Default: Addon |
| apiVersion | String | API version. The value is fixed at v3 and cannot be changed. Default: v3 |
| items | Array of AddonInstance objects | Add-on instance list. |
| Parameter | Type | Description |
|---|---|---|
| kind | String | API type. The value is fixed at Addon and cannot be changed. Default: Addon |
| apiVersion | String | API version. The value is fixed at v3 and cannot be changed. Default: v3 |
| metadata | Metadata object | Basic information about the object. Metadata is a collection of attributes. |
| spec | InstanceSpec object | Detailed description of the add-on instance. |
| status | AddonInstanceStatus object | Add-on instance status. |
| Parameter | Type | Description |
|---|---|---|
| uid | String | Unique ID. |
| name | String | Add-on name. |
| labels | Map<String,String> | Add-on labels in the format of key-value pairs. This is a reserved field. User-defined labels will not take effect. |
| annotations | Map<String,String> | Add-on annotations in the format of key-value pairs.
|
| updateTimestamp | String | Time when the object was updated. |
| creationTimestamp | String | Time when the object was created. |
| Parameter | Type | Description |
|---|---|---|
| clusterID | String | Cluster ID. |
| version | String | Add-on template version, for example, 1.0.0. |
| addonTemplateName | String | Add-on template name, for example, coredns. |
| addonTemplateType | String | Add-on template type. |
| addonTemplateLogo | String | URL for obtaining the add-on template logo. Maximum: 200 |
| addonTemplateLabels | Array of strings | Labels of the add-on template. |
| description | String | Add-on template description. |
| values | Map<String,Object> | Add-on template installation parameters (varying depending on the add-on). Set the parameters accordingly. |
| Parameter | Type | Description |
|---|---|---|
| status | String | Add-on instance status. Enumeration values:
|
| Reason | String | Cause of the add-on installation failure. |
| message | String | Installation error details. |
| targetVersions | Array of strings | Versions to which the current add-on version can be upgraded. |
| currentVersion | Versions object | Information about the current add-on version. |
| Parameter | Type | Description |
|---|---|---|
| version | String | Add-on version. |
| input | Object | Add-on installation parameters. |
| stable | Boolean | Whether the add-on version is a stable release. |
| translate | Object | Translation information used by the GUI. |
| supportVersions | Array of SupportVersions objects | Cluster versions that support the add-on. |
| creationTimestamp | String | Time when the object was created. |
| updateTimestamp | String | Time when the object was updated. |
Example Requests
None
Example Responses
Status code: 200
ok
{
"kind" : "Addon",
"apiVersion" : "v3",
"items" : [ {
"kind" : "Addon",
"apiVersion" : "v3",
"metadata" : {
"uid" : "8ca259cc-553b-11e9-926f-0255ac101a31",
"name" : "storage-driver",
"creationTimestamp" : "2019-04-02T11:36:26Z",
"updateTimestamp" : "2019-04-02T11:36:26Z"
},
"spec" : {
"clusterID" : "0c0e4a63-5539-11e9-95f7-0255ac10177e",
"version" : "1.0.10",
"addonTemplateName" : "storage-driver",
"addonTemplateType" : "helm",
"addonTemplateLogo" : "https://192.149.48.66/cce-addon-southchina-aw1hz2u/storage-driverlogo.svg",
"addonTemplateLabels" : [ "Storage" ],
"description" : "A kubernetes FlexVolume Driver used to support cloud storage",
"values" : {
"basic" : {
"addon_version" : "1.0.10",
"euleros_version" : "2.2.5",
"obs_url" : "obs.cn-north-1.myhuaweicloud.com",
"platform" : "linux-amd64",
"swr_addr" : "100.125.6.246:20202",
"swr_user" : "hwofficial"
},
"flavor" : {
"replicas" : 1
},
"parameters" : { }
}
},
"status" : {
"status" : "running",
"Reason" : "Install complete",
"message" : "",
"currentVersion" : {
"version" : "1.0.10",
"input" : {
"basic" : {
"euleros_version" : "2.2.5",
"obs_url" : "obs.cn-north-1.myhuaweicloud.com",
"swr_addr" : "100.125.6.246:20202",
"swr_user" : "hwofficial"
},
"parameters" : { }
},
"stable" : true,
"translate" : {
"en_US" : {
"addon" : {
"changeLog" : "The plug-in is upgraded to enhance the storage plug-in function.",
"description" : "A kubernetes FlexVolume Driver used to support cloud storage"
}
},
"zh_CN" : {
"addon" : {
"changeLog" : "",
"description" : ""
}
}
},
"creationTimestamp" : "2019-03-29T13:45:37Z",
"updateTimestamp" : "2019-03-29T13:45:37Z"
}
}
} ]
} Status Codes
| Status Code | Description |
|---|---|
| 200 | ok |
Error Codes
See Error Codes.
Last Article: Obtaining Information About an Add-on Instance
Next Article: Add-on Instance Parameter Description
Did this article solve your problem?
Thank you for your score！Your feedback would help us improve the website.