# 获取AddonInstance列表 - ListAutopilotAddonInstances #### 功能介绍 获取集群所有已安装插件实例 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-cce-autopilot/cce_02_0099.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-cce-autopilot/cce_02_0327.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | cce:addonInstance:list | List | cluster \* | - | - | - | | cce:addonInstance:list | List | - | - cce:ClusterId - g:EnterpriseProjectId | - | - | #### URI GET /autopilot/v3/addons 表1Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | addon_template_name | 否 | String | 含义：想要筛选的插件名称或插件别名 属性：隐藏参数 | | cluster_id | 是 | String | 集群 ID，获取方式请参见[如何获取接口URI中参数](https://support.huaweicloud.com/api-cce-autopilot/cce_02_0271.html) | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | Content-Type | 是 | String | **参数解释：** 消息体的类型（格式），默认为application/json，有其他取值时会在具体接口中专门说明。 **约束限制：** GET方法不做校验 **默认取值：** 不涉及 | | X-Auth-Token | 是 | String | **参数解释：** 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值，获取方式请参见[获取token](https://support.huaweicloud.com/api-cce-autopilot/cce_02_0004.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | kind | String | API类型，固定值"Addon"，该值不可修改。 | | apiVersion | String | API版本，固定值"v3"，该值不可修改。 | | items | Array of [AddonInstance] objects | 插件实例列表 | 表4AddonInstance | 参数 | 参数类型 | 描述 | |:---|:---|:---| | kind | String | API类型，固定值"Addon"，该值不可修改。 | | apiVersion | String | API版本，固定值"v3"，该值不可修改。 | | metadata | [AddonMetadata] object | 基本信息，为集合类的元素类型，包含一组由不同名称定义的属性 | | spec | [InstanceSpec] object | spec是集合类的元素类型，内容为插件实例具体信息，实例的详细描述主体部分都在spec中给出 | | status | [AddonInstanceStatus] object | 插件实例状态 | 表5AddonMetadata | 参数 | 参数类型 | 描述 | |:---|:---|:---| | uid | String | 唯一id标识 | | name | String | 插件名称 | | alias | String | 插件别名 | | labels | Map\ | 插件标签，key/value对格式，接口保留字段，填写不会生效 | | annotations | Map\ | 插件注解，由key/value组成 - 安装：固定值为{"addon.install/type":"install"} - 升级：固定值为{"addon.upgrade/type":"upgrade"} | | updateTimestamp | String | 更新时间 | | creationTimestamp | String | 创建时间 | 表6InstanceSpec | 参数 | 参数类型 | 描述 | |:---|:---|:---| | clusterID | String | 集群id | | version | String | 插件模板版本号，如1.0.0 | | addonTemplateName | String | 插件模板名称，如coredns | | addonTemplateType | String | 插件模板类型，固定为helm，表示模板为helm类型 | | addonTemplateLogo | String | 插件模板logo图片的地址 | | addonTemplateLabels | Array of strings | 插件模板所属类型 | | description | String | 插件模板描述 | | values | Map\ | 插件模板安装参数（各插件不同），请根据具体插件模板信息填写安装参数。 | 表7AddonInstanceStatus | 参数 | 参数类型 | 描述 | |:---|:---|:---| | status | String | 插件实例状态, 取值如下 - running：运行中，表示插件全部实例状态都在运行中，插件正常使用。 - abnormal：不可用，表示插件状态异常，插件不可使用。可单击插件名称查看实例异常事件。 - installing：安装中，表示插件正在安装中。 - installFailed：安装失败，表示插件安装失败，需要卸载后重新安装。 - upgrading：升级中，表示插件正在更新中。 - upgradeFailed：升级失败，表示插件升级失败，可重试升级或卸载后重新安装。 - deleting：删除中，表示插件正在删除中。 - deleteFailed：删除失败，表示插件删除失败，可重试卸载。 - deleteSuccess：删除成功，表示插件删除成功。 - available：部分就绪，表示插件下只有部分实例状态为运行中，插件部分功能可用。 - rollbacking：回滚中，表示插件正在回滚中。 - rollbackFailed：回滚失败，表示插件回滚失败，可重试回滚或卸载后重新安装。 - unknown：未知状态，表示插件模板实例不存在。 | | Reason | String | 插件安装失败原因 | | message | String | 安装错误详情 | | targetVersions | Array of strings | 此插件版本，支持升级的集群版本 | | currentVersion | [Versions] object | 当前插件实例使用的具体插件版本信息 | | isRollbackable | Boolean | 是否支持回滚到插件升级前的插件版本 | | previousVersion | String | 插件升级或回滚前的版本 | 表8Versions | 参数 | 参数类型 | 描述 | |:---|:---|:---| | version | String | 插件版本号 | | input | Object | 插件安装参数 | | stable | Boolean | 是否为稳定版本 | | translate | Object | 供界面使用的翻译信息 | | supportVersions | Array of [SupportVersions] objects | 支持集群版本号 | | creationTimestamp | String | 创建时间 | | updateTimestamp | String | 更新时间 | 表9SupportVersions | 参数 | 参数类型 | 描述 | |:---|:---|:---| | clusterType | String | **参数解释**： 支持的集群类型 **取值范围**： - VirtualMachine: CCE集群，控制节点架构为X86 - ARM64: 鲲鹏集群，控制节点架构为鲲鹏 **约束限制**： CCE Autopilot集群仅支持VirtualMachine类型 | | clusterVersion | Array of strings | 支持的集群版本（正则表达式） | | category | Array of strings | 作用的集群类型 **取值范围：** - CCE：CCE Standard集群 - Turbo：CCE Turbo集群 - Autopilot：CCE Autopilot集群 **默认取值** 为空时默认为CCE Standard，CCE Turbo集群 | #### 请求示例 无 #### 响应示例 **状态码：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 (e.g. “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 ability - External domain name：2500 qps, Internal domain name：10000 qps", "Parameters.flavor1.name" : 2500, "Parameters.flavor2.description" : "Concurrent domain name resolution ability - External domain name：5000 qps, Internal domain name：20000 qps", "Parameters.flavor2.name" : 5000, "Parameters.flavor3.description" : "Concurrent domain name resolution ability - External domain name：10000 qps, Internal domain name：40000 qps", "Parameters.flavor3.name" : 10000, "Parameters.flavor4.description" : "Concurrent domain name resolution ability - 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集群", "description" : "CoreDNS是一款通过链式插件的方式给Kubernetes提供DNS解析服务的DNS服务器" }, "description" : { "Parameters.custom.stub_domains" : "用户可对自定义的域名配置域名服务器，格式为一个键值对，键为DNS后缀域名，值为一个或一组DNS IP地址，如\"acme.local -- 1.2.3.4,6.7.8.9\"。", "Parameters.custom.upstream_nameservers" : "解析除集群内服务域名以及自定义域名之外的域名地址，格式为一个或一组DNS IP地址，如\"8.8.8.8\",\"8.8.4.4\"。", "Parameters.flavor1.description" : "并发域名解析能力 - 外部域名：2500 qps，内部域名：10000 qps", "Parameters.flavor1.name" : 2500, "Parameters.flavor2.description" : "并发域名解析能力 - 外部域名：5000 qps，内部域名：20000 qps", "Parameters.flavor2.name" : 5000, "Parameters.flavor3.description" : "并发域名解析能力 - 外部域名：10000 qps，内部域名：40000 qps", "Parameters.flavor3.name" : 10000, "Parameters.flavor4.description" : "并发域名解析能力 - 外部域名：20000 qps，内部域名：80000 qps", "Parameters.flavor4.name" : 20000 }, "key" : { "Parameters.custom.stub_domains" : "存根域", "Parameters.custom.upstream_nameservers" : "上游域名服务器" } } }, "supportVersions" : null, "creationTimestamp" : "2024-02-19T11:33:46Z", "updateTimestamp" : "2024-02-21T01:24:05Z" } } } ] } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` 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("")) .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()); } } } ``` - [Python] ``` # 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("")) \ .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) ``` - [Go] ``` 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("")). WithCredential(auth). Build()) request := &model.ListAutopilotAddonInstancesRequest{} response, err := client.ListAutopilotAddonInstances(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CCE/sdk?api=ListAutopilotAddonInstances)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | ok | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-cce-autopilot/ErrorCode.html)。