功能介紹
獲取集群所有已安裝插件實(shí)例
調(diào)用方法
請(qǐng)參見(jiàn)如何調(diào)用API。
URI
GET /api/v3/addons
|
參數(shù) |
是否必選 |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|---|
|
cluster_id |
是 |
String |
集群 ID,獲取方式請(qǐng)參見(jiàn)如何獲取接口URI中參數(shù) |
請(qǐng)求參數(shù)
|
參數(shù) |
是否必選 |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|---|
|
Content-Type |
是 |
String |
消息體的類(lèi)型(格式) |
|
X-Auth-Token |
是 |
String |
調(diào)用接口的認(rèn)證方式分為T(mén)oken和AK/SK兩種,如果您使用的Token方式,此參數(shù)為必填,請(qǐng)?zhí)顚?xiě)Token的值,獲取方式請(qǐng)參見(jiàn)獲取token。 |
響應(yīng)參數(shù)
狀態(tài)碼: 200
|
參數(shù) |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|
|
kind |
String |
API類(lèi)型,固定值“Addon”,該值不可修改。 |
|
apiVersion |
String |
API版本,固定值“v3”,該值不可修改。 |
|
items |
插件實(shí)例列表 |
|
參數(shù) |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|
|
kind |
String |
API類(lèi)型,固定值“Addon”,該值不可修改。 |
|
apiVersion |
String |
API版本,固定值“v3”,該值不可修改。 |
|
metadata |
基本信息,為集合類(lèi)的元素類(lèi)型,包含一組由不同名稱(chēng)定義的屬性 |
|
|
spec |
spec是集合類(lèi)的元素類(lèi)型,內(nèi)容為插件實(shí)例具體信息,實(shí)例的詳細(xì)描述主體部分都在spec中給出 |
|
|
status |
插件實(shí)例狀態(tài) |
|
參數(shù) |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|
|
uid |
String |
唯一id標(biāo)識(shí) |
|
name |
String |
插件名稱(chēng) |
|
alias |
String |
插件別名 |
|
labels |
Map<String,String> |
插件標(biāo)簽,key/value對(duì)格式,接口保留字段,填寫(xiě)不會(huì)生效 |
|
annotations |
Map<String,String> |
插件注解,由key/value組成
|
|
updateTimestamp |
String |
更新時(shí)間 |
|
creationTimestamp |
String |
創(chuàng)建時(shí)間 |
|
參數(shù) |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|
|
clusterID |
String |
集群id |
|
version |
String |
插件模板版本號(hào),如1.0.0 |
|
addonTemplateName |
String |
插件模板名稱(chēng),如coredns |
|
addonTemplateType |
String |
插件模板類(lèi)型 |
|
addonTemplateLogo |
String |
插件模板logo圖片的地址 |
|
addonTemplateLabels |
Array of strings |
插件模板所屬類(lèi)型 |
|
description |
String |
插件模板描述 |
|
values |
Map<String,Object> |
插件模板安裝參數(shù)(各插件不同),請(qǐng)根據(jù)具體插件模板信息填寫(xiě)安裝參數(shù)。 |
|
參數(shù) |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|
|
status |
String |
插件實(shí)例狀態(tài), 取值如下
|
|
Reason |
String |
插件安裝失敗原因 |
|
message |
String |
安裝錯(cuò)誤詳情 |
|
targetVersions |
Array of strings |
此插件版本,支持升級(jí)的集群版本 |
|
currentVersion |
當(dāng)前插件實(shí)例使用的具體插件版本信息 |
|
|
isRollbackable |
Boolean |
是否支持回滾到插件升級(jí)前的插件版本 |
|
previousVersion |
String |
插件升級(jí)或回滾前的版本 |
請(qǐng)求示例
無(wú)
響應(yīng)示例
狀態(tài)碼: 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代碼示例
SDK代碼示例如下。
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) {
String ak = "<YOUR AK>";
String sk = "<YOUR SK>";
ICredential auth = new BasicCredentials()
.withAk(ak)
.withSk(sk);
CceClient client = CceClient.newBuilder()
.withCredential(auth)
.withRegion(CceRegion.valueOf("cn-north-4"))
.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());
}
}
}
# coding: utf-8
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__":
ak = "<YOUR AK>"
sk = "<YOUR SK>"
credentials = BasicCredentials(ak, sk) \
client = CceClient.new_builder() \
.with_credentials(credentials) \
.with_region(CceRegion.value_of("cn-north-4")) \
.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)
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() {
ak := "<YOUR AK>"
sk := "<YOUR SK>"
auth := basic.NewCredentialsBuilder().
WithAk(ak).
WithSk(sk).
Build()
client := cce.NewCceClient(
cce.CceClientBuilder().
WithRegion(region.ValueOf("cn-north-4")).
WithCredential(auth).
Build())
request := &model.ListAddonInstancesRequest{}
response, err := client.ListAddonInstances(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
更多編程語(yǔ)言的SDK代碼示例,請(qǐng)參見(jiàn)API Explorer的代碼示例頁(yè)簽,可生成自動(dòng)對(duì)應(yīng)的SDK代碼示例。
狀態(tài)碼
|
狀態(tài)碼 |
描述 |
|---|---|
|
200 |
ok |
錯(cuò)誤碼
請(qǐng)參見(jiàn)錯(cuò)誤碼。
