获取AddonInstance列表 - ListAddonInstances
功能介绍
获取集群所有已安装插件实例
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
URI
GET /api/v3/addons
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| cluster_id | 是 | String | 参数解释: 集群ID,获取方式请参见如何获取接口URI中参数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Content-Type | 是 | String | 参数解释: 消息体的类型(格式),默认为application/json,有其他取值时会在具体接口中专门说明。 约束限制: GET方法不做校验 取值范围: 不涉及 默认取值: 不涉及 |
| X-Auth-Token | 是 | String | 参数解释: 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值,获取方式请参见获取token。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| kind | String | 参数解释: API类型,固定值"Addon",该值不可修改。 取值范围: |
| apiVersion | String | 参数解释: API版本,固定值"v3",该值不可修改。 取值范围: |
| items | Array of AddonInstance objects | 参数解释: 插件实例列表。 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| kind | String | 参数解释: API类型,固定值"Addon",该值不可修改。 取值范围: |
| apiVersion | String | 参数解释: API版本,固定值"v3",该值不可修改。 取值范围: |
| metadata | AddonMetadata object | 参数解释: 基本信息,为集合类的元素类型,包含一组由不同名称定义的属性 取值范围: 不涉及 |
| spec | InstanceSpec object | 参数解释: spec是集合类的元素类型,内容为插件实例具体信息,实例的详细描述主体部分都在spec中给出。 取值范围: 不涉及 |
| status | AddonInstanceStatus object | 参数解释: 插件实例状态信息。 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| uid | String | 参数解释: 插件实例唯一ID标识,创建成功后系统自动生成。 取值范围: 不涉及 |
| name | String | 参数解释: 插件名称 取值范围: 不涉及 |
| alias | String | 参数解释: 插件别名。 取值范围: 不涉及 |
| labels | Map<String,String> | 参数解释: 插件标签,key/value对格式,接口保留字段,填写不会生效。 取值范围: 不涉及 |
| annotations | Map<String,String> | 参数解释: 插件注解,由key/value组成。 取值范围: |
| updateTimestamp | String | 参数解释: 更新时间 取值范围: 不涉及 |
| creationTimestamp | String | 参数解释: 创建时间,创建成功后系统自动生成,填写无效。 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| clusterID | String | 参数解释: 集群ID 取值范围: 不涉及 |
| version | String | 参数解释: 插件模板版本号,如1.0.0。 取值范围: 不涉及 |
| addonTemplateName | String | 参数解释: 插件模板名称,如coredns。 取值范围: 不涉及 |
| addonTemplateType | String | 参数解释: 插件模板类型。 取值范围: |
| addonTemplateLogo | String | 参数解释: 插件模板logo图片的地址。 取值范围: 不涉及 |
| addonTemplateLabels | Array of strings | 参数解释: 插件模板所属类型。 取值范围: 不涉及 |
| description | String | 参数解释: 插件模板描述。 取值范围: 不涉及 |
| values | Map<String,Object> | 参数解释: 插件模板安装参数(各插件不同),请根据具体插件模板信息填写安装参数。 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释: 插件实例状态。 取值范围: |
| Reason | String | 参数解释: 插件安装失败原因。 取值范围: 不涉及 |
| message | String | 参数解释: 安装错误详情。 取值范围: 不涉及 |
| targetVersions | Array of strings | 参数解释: 此插件版本,支持升级的集群版本。 取值范围: 不涉及 |
| currentVersion | Versions object | 参数解释: 当前插件实例使用的具体插件版本信息。 取值范围: 不涉及 |
| isRollbackable | Boolean | 参数解释: 是否支持回滚到插件升级前的插件版本。 取值范围: |
| previousVersion | String | 参数解释: 插件升级或回滚前的版本。 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| version | String | 参数解释: 插件版本号。 取值范围: 不涉及 |
| input | Object | 参数解释: 插件安装参数。 取值范围: 不涉及 |
| stable | Boolean | 参数解释: 是否为稳定版本。 取值范围: |
| translate | Object | 参数解释: 供界面使用的翻译信息。 取值范围: 不涉及 |
| supportVersions | Array of SupportVersions objects | 参数解释: 支持集群版本号。 取值范围: 不涉及 |
| creationTimestamp | String | 参数解释: 创建时间。 取值范围: 不涉及 |
| updateTimestamp | String | 参数解释: 更新时间。 取值范围: 不涉及 |
请求示例
无
响应示例
状态码:200
表示获取插件实例列表成功。
{
"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代码示例
SDK代码示例如下。
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 36 37 38 39 40 41 42 43 44 45 46 47 | 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := cce.CceClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := cce.NewCceClient(hcClient) request := &model.ListAddonInstancesRequest{} response, err := client.ListAddonInstances(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示获取插件实例列表成功。 |
错误码
请参见错误码。