Listing Add-on Instances
Function
This API is used to list all add-on instances in the cluster.
Calling Method
For details, see Calling APIs.
URI
GET /api/v3/addons
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
cluster_id |
Yes |
String |
Cluster ID. For details about how to obtain a 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). |
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, see Obtaining a User Token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
kind |
String |
API type. The value is fixed at Addon and cannot be changed. |
apiVersion |
String |
API version. The value is fixed at v3 and cannot be changed. |
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. |
apiVersion |
String |
API version. The value is fixed at v3 and cannot be changed. |
metadata |
AddonMetadata 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 |
alias |
String |
Add-on alias |
labels |
Map<String,String> |
Add-on labels in key-value pairs. This is a reserved field and does not take effect. |
annotations |
Map<String,String> |
Add-on annotations in the format of key-value pairs.
|
updateTimestamp |
String |
Updated at |
creationTimestamp |
String |
Created at |
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. |
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. Options:
|
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. |
isRollbackable |
Boolean |
Whether the add-on version can be rolled back to the source version. |
previousVersion |
String |
The add-on version before upgrade or rollback |
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 |
Creation time. |
updateTimestamp |
String |
Update time. |
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", "alias" : "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" : "", "platform" : "linux-amd64", "swr_addr" : "100.125.6.246:20202", "swr_user" : "hwofficial" }, "flavor" : { "replicas" : 1 }, "parameters" : { } } }, "status" : { "status" : "running", "Reason" : "Install complete", "message" : "", "targetVersions" : null, "currentVersion" : { "version" : "1.0.10", "input" : { "basic" : { "euleros_version" : "2.2.5", "obs_url" : "", "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" : "" } } }, "supportVersions" : null, "creationTimestamp" : "2019-03-29T13:45:37Z", "updateTimestamp" : "2019-03-29T13:45:37Z" } } } ] }
SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.cce.v3.region.CceRegion; import com.huaweicloud.sdk.cce.v3.*; import com.huaweicloud.sdk.cce.v3.model.*; public class ListAddonInstancesSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); CceClient client = CceClient.newBuilder() .withCredential(auth) .withRegion(CceRegion.valueOf("<YOUR REGION>")) .build(); ListAddonInstancesRequest request = new ListAddonInstancesRequest(); try { ListAddonInstancesResponse response = client.listAddonInstances(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcce.v3.region.cce_region import CceRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcce.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = CceClient.new_builder() \ .with_credentials(credentials) \ .with_region(CceRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListAddonInstancesRequest() response = client.list_addon_instances(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" cce "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := cce.NewCceClient( cce.CceClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListAddonInstancesRequest{} response, err := client.ListAddonInstances(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
ok |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot