Help Center/ Cloud Container Engine_Autopilot/ API Reference/ APIs/ Add-on Management for Autopilot Clusters/ Listing Add-on Instances
Updated on 2024-11-12 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Listing Add-on Instances

Function

This API is used to obtain all add-on instances in a cluster.

Calling Method

For details, see Calling APIs.

URI

GET /autopilot/v3/addons

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

cluster_id

Yes

String

Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Details:

Request body type or format

Constraints:

The GET method is not verified.

Options:

  • application/json

  • application/json;charset=utf-8

  • application/x-pem-file

Default value:

N/A

X-Auth-Token

Yes

String

Details:

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.

Constraints:

None

Options:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

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.
Table 4 AddonInstance

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.
Table 5 AddonMetadata

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.

  • For add-on installation, the value is fixed at {"addon.install/type":"install"}.

  • For add-on upgrade, the value is fixed at {"addon.upgrade/type":"upgrade"}.

updateTimestamp

String

Updated at

creationTimestamp

String

Created at
Table 6 InstanceSpec

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.
Table 7 AddonInstanceStatus

Parameter

Type

Description

status

String

Add-on instance status. Options:

  • running: All of the add-on instances are running. This specifies that the add-on runs properly.

  • abnormal: The add-on instances are abnormal and the add-on cannot be used. You can click the add-on name to view exceptions.

  • installing: The add-on is being installed.

  • installFailed: Installing the add-on failed. In this case, uninstall the add-on and then reinstall it.

  • upgrading: The add-on is being upgraded.

  • upgradeFailed: Upgrading the add-on failed. In this case, upgrade the add-on again or uninstall the add-on and reinstall it.

  • deleting: The add-on is being deleted.

  • deleteFailed: Deleting the add-on failed. In this case, uninstall the add-on again.

  • deleteSuccess: Deleting the add-on succeeded.

  • available: Only some instances of the add-on are running. This specifies that some functions of the add-on are available.

  • rollbacking: The add-on is being rolled back.

  • rollbackFailed: Rolling back the add-on failed. In this case, roll back the add-on again or uninstall the add-on and reinstall it.

  • unknown: The add-on chart instance does not exist.

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
Table 8 Versions

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.
Table 9 SupportVersions

Parameter

Type

Description

clusterType

String

Cluster type that supports the add-on.

clusterVersion

Array of strings

Cluster versions that support the add-on. The value is a regular expression.

Example Requests

None

Example Responses

Status code: 200

ok

{
  "kind" : "Addon",
  "apiVersion" : "v3",
  "items" : [ {
    "kind" : "Addon",
    "apiVersion" : "v3",
    "metadata" : {
      "uid" : "90b775e0-5774-4e1d-ab3b-516332ba047a",
      "name" : "coredns",
      "alias" : "coredns",
      "creationTimestamp" : "2024-07-18T04:04:21Z",
      "updateTimestamp" : "2024-07-18T04:04:21Z"
    },
    "spec" : {
      "clusterID" : "597f2d95-44ab-11ef-9e39-0255ac100115",
      "version" : "1.28.6",
      "addonTemplateName" : "coredns",
      "addonTemplateType" : "helm",
      "addonTemplateLogo" : "",
      "addonTemplateLabels" : [ "ContainerNetwork" ],
      "description" : "CoreDNS is a DNS server that chains plugins and provides Kubernetes DNS Services",
      "values" : null
    },
    "status" : {
      "status" : "installing",
      "Reason" : "",
      "message" : "",
      "targetVersions" : null,
      "isRollbackable" : false,
      "currentVersion" : {
        "version" : "1.28.6",
        "input" : {
          "basic" : {
            "cluster_ip" : "10.247.3.10",
            "image_version" : "1.28.6",
            "swr_addr" : "swr.cn-north-7.myhuaweicloud.com",
            "swr_user" : "autopilot-official"
          },
          "parameters" : {
            "autopilot-flavor1" : {
              "category" : [ "Autopilot" ],
              "is_default" : true,
              "name" : "autopilot-flavor1",
              "replicas" : 2,
              "resources" : [ {
                "limitsCpu" : 1,
                "limitsMem" : "2Gi",
                "name" : "coredns",
                "requestsCpu" : 1,
                "requestsMem" : "2Gi"
              } ]
            },
            "custom" : {
              "multiAZBalance" : false,
              "multiAZEnabled" : false,
              "node_match_expressions" : [ ],
              "parameterSyncStrategy" : "ensureConsistent",
              "servers" : [ {
                "plugins" : [ {
                  "name" : "bind",
                  "parameters" : "{$POD_IP}"
                }, {
                  "configBlock" : "servfail 5s",
                  "name" : "cache",
                  "parameters" : 30
                }, {
                  "name" : "errors"
                }, {
                  "name" : "health",
                  "parameters" : "{$POD_IP}:8080"
                }, {
                  "name" : "ready",
                  "parameters" : "{$POD_IP}:8081"
                }, {
                  "configBlock" : "pods insecure\nfallthrough in-addr.arpa ip6.arpa",
                  "name" : "kubernetes",
                  "parameters" : "cluster.local in-addr.arpa ip6.arpa"
                }, {
                  "name" : "loadbalance",
                  "parameters" : "round_robin"
                }, {
                  "name" : "prometheus",
                  "parameters" : "{$POD_IP}:9153"
                }, {
                  "configBlock" : "policy random",
                  "name" : "forward",
                  "parameters" : ". /etc/resolv.conf"
                }, {
                  "name" : "reload"
                } ],
                "port" : 5353,
                "zones" : [ {
                  "zone" : "."
                } ]
              } ],
              "stub_domains" : { },
              "tolerations" : [ {
                "effect" : "NoExecute",
                "key" : "node.kubernetes.io/not-ready",
                "operator" : "Exists",
                "tolerationSeconds" : 60
              }, {
                "effect" : "NoExecute",
                "key" : "node.kubernetes.io/unreachable",
                "operator" : "Exists",
                "tolerationSeconds" : 60
              } ],
              "upstream_nameservers" : [ ]
            },
            "flavor1" : {
              "is_default" : true,
              "name" : 2500,
              "recommend_cluster_flavor_types" : [ "small" ],
              "replicas" : 2,
              "resources" : [ {
                "limitsCpu" : "500m",
                "limitsMem" : "512Mi",
                "name" : "coredns",
                "requestsCpu" : "500m",
                "requestsMem" : "512Mi"
              } ]
            },
            "flavor2" : {
              "name" : 5000,
              "recommend_cluster_flavor_types" : [ "medium" ],
              "replicas" : 2,
              "resources" : [ {
                "limitsCpu" : "1000m",
                "limitsMem" : "1024Mi",
                "name" : "coredns",
                "requestsCpu" : "1000m",
                "requestsMem" : "1024Mi"
              } ]
            },
            "flavor3" : {
              "name" : 10000,
              "recommend_cluster_flavor_types" : [ "large" ],
              "replicas" : 2,
              "resources" : [ {
                "limitsCpu" : "2000m",
                "limitsMem" : "2048Mi",
                "name" : "coredns",
                "requestsCpu" : "2000m",
                "requestsMem" : "2048Mi"
              } ]
            },
            "flavor4" : {
              "name" : 20000,
              "recommend_cluster_flavor_types" : [ "xlarge" ],
              "replicas" : 4,
              "resources" : [ {
                "limitsCpu" : "2000m",
                "limitsMem" : "2048Mi",
                "name" : "coredns",
                "requestsCpu" : "2000m",
                "requestsMem" : "2048Mi"
              } ]
            }
          }
        },
        "stable" : true,
        "translate" : {
          "en_US" : {
            "addon" : {
              "changeLog" : "Support autopilot cluster",
              "description" : "CoreDNS is a DNS server that chains plugins and provides Kubernetes DNS Services"
            },
            "description" : {
              "Parameters.custom.stub_domains" : "The target nameserver may itself be a Kubernetes service. For instance, you can run your own copy of dnsmasq to export custom DNS names into the ClusterDNS namespace, a JSON map using a DNS suffix key (for example, **\"acme.local\"**) and a value consisting of a JSON array of DNS IPs.",
              "Parameters.custom.upstream_nameservers" : "If specified, then the values specified replace the nameservers taken by default from the node's **/etc/resolv.conf**. Limits: A maximum of three upstream nameservers can be specified. (A JSON array of DNS IPs.)",
              "Parameters.flavor1.description" : "Concurrent domain name resolution capability - external domain name: 2500 qps, internal domain name: 10000 qps",
              "Parameters.flavor1.name" : 2500,
              "Parameters.flavor2.description" : "Concurrent domain name resolution capability - external domain name: 5000 qps, internal domain name: 20000 qps",
              "Parameters.flavor2.name" : 5000,
              "Parameters.flavor3.description" : "Concurrent domain name resolution capability - external domain name: 10000 qps, internal domain name: 40000 qps",
              "Parameters.flavor3.name" : 10000,
              "Parameters.flavor4.description" : "Concurrent domain name resolution capability - external domain name: 20000 qps, internal domain name: 80000 qps",
              "Parameters.flavor4.name" : 20000
            },
            "key" : {
              "Parameters.custom.stub_domains" : "stub domain",
              "Parameters.custom.upstream_nameservers" : "upstream nameservers"
            }
          },
          "fr_FR" : {
            "addon" : {
              "changeLog" : "les spécifications du plugin peuvent être associées aux spécifications du cluster. le fuseau horaire du plug-in est le même que celui du noeud",
              "description" : "Un serveur DNS qui enchaîne les plug-ins et fournit des services DNS Kubernetes."
            },
            "description" : {
              "Parameters.custom.stub_domains" : "Le serveur de noms cible peut lui-même être un service Kubernetes. Par exemple, vous pouvez exécuter votre propre copie de dnsmasq pour exporter des noms DNS personnalisés dans l'espace de noms ClusterDNS, une carte JSON à l'aide d'une clé de suffixe DNS (par exemple, «acme.local») et une valeur constituée d'un tableau JSON d'adresses IP DNS.",
              "Parameters.custom.upstream_nameservers" : "Si spécifié, les valeurs spécifiées remplacent les serveurs de noms pris par défaut dans le fichier /etc/resolv.conf du nœud. Limites: un maximum de trois serveurs de noms en amont peuvent être spécifiés, un tableau JSON d'adresses IP DNS.",
              "Parameters.flavor1.description" : "Capacité de résolution de nom de domaine simultanée - Nom de domaine externe: 2500 qps, Nom de domaine interne: 10000 qp",
              "Parameters.flavor1.name" : 2500,
              "Parameters.flavor2.description" : "Capacité de résolution de nom de domaine simultanée - Nom de domaine externe: 5000 qps, Nom de domaine interne: 20000 qp",
              "Parameters.flavor2.name" : 5000,
              "Parameters.flavor3.description" : "Capacité de résolution de nom de domaine simultanée - Nom de domaine externe: 10000 qps, Nom de domaine interne: 40000 qp",
              "Parameters.flavor3.name" : 10000,
              "Parameters.flavor4.description" : "Capacité de résolution de nom de domaine simultanée - Nom de domaine externe: 20000 qps, Nom de domaine interne: 80000 qp",
              "Parameters.flavor4.name" : 20000
            },
            "key" : {
              "Parameters.custom.stub_domains" : "domaine stub",
              "Parameters.custom.upstream_nameservers" : "serveurs de noms en amont"
            }
          },
          "zh_CN" : {
            "addon" : {
              "changeLog" : "Autopilot clusters are supported.",
              "description" : "CoreDNS is a DNS server that chains plug-ins and offers DNS resolution for Kubernetes clusters."
            },
            "description" : {
              "Parameters.custom.stub_domains" : "A domain name server for a custom domain name in key-value pair. The key is a suffix of DNS domain name, and the value is one or more DNS IP addresses, for example, **acme.local -- 1.2.3.4,6.7.8.9**.",
              "Parameters.custom.upstream_nameservers" : "Resolves all domain names except intra-cluster service domain names and custom domain names. The value can be one or more DNS IP addresses, for example, **\"8.8.8.8\",\"8.8.4.4\"**.",
              "Parameters.flavor1.description" : "Concurrent domain name resolution capability - external domain name: 2500 qps, internal domain name: 10000 qps",
              "Parameters.flavor1.name" : 2500,
              "Parameters.flavor2.description" : "Concurrent domain name resolution capability - external domain name: 5000 qps, internal domain name: 20000 qps",
              "Parameters.flavor2.name" : 5000,
              "Parameters.flavor3.description" : "Concurrent domain name resolution capability - external domain name: 10000 qps, internal domain name: 40000 qps",
              "Parameters.flavor3.name" : 10000,
              "Parameters.flavor4.description" : "Concurrent domain name resolution capability - external domain name: 20000 qps, internal domain name: 80000 qps",
              "Parameters.flavor4.name" : 20000
            },
            "key" : {
              "Parameters.custom.stub_domains" : "Stub domain",
              "Parameters.custom.upstream_nameservers" : "Upstream DNS server"
            }
          }
        },
        "supportVersions" : null,
        "creationTimestamp" : "2024-02-19T11:33:46Z",
        "updateTimestamp" : "2024-02-21T01:24:05Z"
      }
    }
  } ]
}

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 ListAutopilotAddonInstancesSolution {

    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();
        ListAutopilotAddonInstancesRequest request = new ListAutopilotAddonInstancesRequest();
        try {
            ListAutopilotAddonInstancesResponse response = client.listAutopilotAddonInstances(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 = ListAutopilotAddonInstancesRequest()
        response = client.list_autopilot_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.ListAutopilotAddonInstancesRequest{}
	response, err := client.ListAutopilotAddonInstances(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.

Parent Topic: Add-on Management for Autopilot Clusters