文档首页 > > API参考> API> 插件管理> 查询AddonTemplates列表

查询AddonTemplates列表

分享
更新时间:2020/10/26 GMT+08:00

功能介绍

插件模板查询接口,查询插件信息。

插件管理的URL格式为:https://{clusterid}.Endpoint/uri。其中{clusterid}为集群ID,uri为资源路径,也即API访问的路径。

调试

您可以在API Explorer中调试该接口。

URI

GET /api/v3/addontemplates

表1 Query参数

参数

是否必选

参数类型

描述

addon_template_name

String

指定的模板名称,不填写则查询列表。

最小长度:2

最大长度:30

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

消息体的类型(格式)

枚举值:

  • application/json;charset=utf-8

  • application/json

X-Auth-Token

String

调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值,获取方式请参见获取token

最大长度:16384

响应参数

状态码为 200 时:

表3 响应Body参数

参数

参数类型

描述

kind

String

API类型,固定值“Addon”,该值不可修改。

缺省值:Addon

apiVersion

String

API版本,固定值“v3”,该值不可修改。

缺省值:v3

metadata

String

基本信息,为集合类的元素类型,包含一组由不同名称定义的属性

items

Array of AddonTemplate objects

插件模板列表

表4 AddonTemplate

参数

参数类型

描述

kind

String

API类型,固定值“Addon”,该值不可修改。

缺省值:Addon

apiVersion

String

API版本,固定值“v3”,该值不可修改。

缺省值:v3

metadata

Metadata object

基本信息,为集合类的元素类型,包含一组由不同名称定义的属性

spec

Templatespec object

spec是集合类的元素类型,内容为插件模板具体信息,插件模板的详细描述主体部分都在spec中给出

表5 Metadata

参数

参数类型

描述

uid

String

唯一id标识

name

String

插件名称

labels

Map<String,String>

插件标签,key/value对格式

annotations

Map<String,String>

插件注解,由key/value组成

  • 安装:固定值为{"addon.install/type":"install"}

  • 升级:固定值为{"addon.upgrade/type":"upgrade"}

updateTimestamp

String

更新时间

creationTimestamp

String

创建时间

表6 Templatespec

参数

参数类型

描述

type

String

模板类型(helm,static)

require

Boolean

是否为必安装插件

labels

Array of strings

模板所属分组

logoURL

String

Logo图片地址

readmeURL

String

插件详情描述及使用说明

description

String

模板描述

versions

Array of Versions objects

模板具体版本详情

表7 Versions

参数

参数类型

描述

version

String

插件版本号

input

Object

插件安装参数

stable

Boolean

是否为稳定版本

translate

Object

供界面使用的翻译信息

supportVersions

Array of SupportVersions objects

支持集群版本号

creationTimestamp

String

创建时间

updateTimestamp

String

更新时间

表8 SupportVersions

参数

参数类型

描述

clusterType

String

支持的集群类型

clusterVersion

Array of strings

支持的集群版本(正则表达式)

请求示例

响应示例

状态码为 200 时:

OK

{
  "kind" : "Addon",
  "apiVersion" : "v3",
  "items" : [ {
    "kind" : "Addon",
    "apiVersion" : "v3",
    "metadata" : {
      "uid" : "web-terminal",
      "name" : "web-terminal",
      "creationTimestamp" : "2019-01-07T13:22:48Z",
      "updateTimestamp" : "2019-03-28T06:52:58Z"
    },
    "spec" : {
      "type" : "helm",
      "labels" : [ "Maintenance" ],
      "logoURL" : "https://192.149.48.66/cce-addon-southchina-aw1hz2u/web-terminallogo.svg",
      "readmeURL" : "https://192.149.48.66/cce-addon-southchina-y24tcmvhzg1l/web-terminalcn-readme.md##https://192.149.48.66/cce-addon-southchina-zw4tcmvhzg1l/web-terminalen-readme.md",
      "description" : "A plug-in that allows users to run kubectl commands using a web browser.",
      "versions" : [ {
        "version" : "1.0.0",
        "input" : {
          "basic" : {
            "euleros_version" : "2.2.5",
            "swr_addr" : "100.125.6.246:20202",
            "swr_user" : "hwofficial"
          },
          "parameters" : {
            "custom" : {
              "password" : "hwcloud_cce"
            },
            "flavor1" : {
              "description" : "Has only one instance",
              "name" : "Single",
              "replicas" : 1,
              "resources" : [ {
                "limitsCpu" : "200m",
                "limitsMem" : "512Mi",
                "name" : "web-terminal",
                "requestsCpu" : "100m",
                "requestsMem" : "256Mi"
              } ]
            }
          }
        },
        "stable" : true,
        "translate" : {
          "en_US" : {
            "addon" : {
              "changeLog" : "none",
              "description" : "A plug-in that allows users to run kubectl commands using a web browser."
            },
            "description" : {
              "Parameters.flavor1.description" : "Deploy with one instance",
              "Parameters.flavor1.name" : "Single"
            },
            "key" : {
              "Parameters.custom.password" : "password"
            }
          },
          "zh_CN" : {
            "addon" : {
              "changeLog" : "无",
              "description" : "一款支持在web界面上使用kubectl的插件。"
            },
            "description" : {
              "Parameters.flavor1.description" : "单实例部署",
              "Parameters.flavor1.name" : "单实例"
            },
            "key" : {
              "Parameters.custom.password" : "密码"
            }
          }
        },
        "supportVersions" : [ {
          "clusterType" : "VirtualMachine",
          "clusterVersion" : [ "v1.(9|11).*" ]
        }, {
          "clusterType" : "BareMetal",
          "clusterVersion" : [ "v1.(9|11).*" ]
        } ],
        "creationTimestamp" : "2019-01-07T13:22:48Z",
        "updateTimestamp" : "2019-02-22T07:01:16Z"
      }, {
        "version" : "1.0.1",
        "input" : {
          "basic" : {
            "euleros_version" : "2.2.5",
            "rbac_enabled" : true,
            "swr_addr" : "100.125.6.246:20202",
            "swr_user" : "hwofficial"
          },
          "parameters" : {
            "custom" : {
              "elbClass" : "union",
              "elbID" : 0,
              "loadBalancerIP" : "127.0.0.1",
              "password" : "hwcloud_cce",
              "port" : 3000,
              "serviceType" : "NodePort",
              "targetPort" : 3000
            },
            "flavor1" : {
              "description" : "Has only one instance",
              "name" : "Single",
              "replicas" : 1,
              "resources" : [ {
                "limitsCpu" : "200m",
                "limitsMem" : "512Mi",
                "name" : "web-terminal",
                "requestsCpu" : "100m",
                "requestsMem" : "256Mi"
              } ]
            }
          }
        },
        "stable" : true,
        "translate" : {
          "en_US" : {
            "addon" : {
              "changeLog" : "1.include service creation  2.simplify operation  3.support access via elb",
              "description" : "A plug-in that allows users to run kubectl commands using a web browser."
            },
            "description" : {
              "Parameters.custom.serviceType" : "Service type for accessing web-terminal",
              "Parameters.flavor1.description" : "Deploy with one instance",
              "Parameters.flavor1.name" : "Single"
            },
            "key" : {
              "Parameters.custom.serviceType" : "Access type"
            }
          },
          "zh_CN" : {
            "addon" : {
              "changeLog" : "1.包含service创建  2.操作简化  3.支持通过elb访问",
              "description" : "一款支持在web界面上使用kubectl的插件。"
            },
            "description" : {
              "Parameters.custom.serviceType" : "访问web-terminal的service类型",
              "Parameters.flavor1.description" : "单实例部署",
              "Parameters.flavor1.name" : "单实例"
            },
            "key" : {
              "Parameters.custom.serviceType" : "访问类型"
            }
          }
        },
        "supportVersions" : [ {
          "clusterType" : "VirtualMachine",
          "clusterVersion" : [ "v1.(9|11).*" ]
        }, {
          "clusterType" : "BareMetal",
          "clusterVersion" : [ "v1.(9|11).*" ]
        } ],
        "creationTimestamp" : "2019-03-28T06:52:57Z",
        "updateTimestamp" : "2019-03-28T06:52:57Z"
      } ]
    }
  } ]
}

状态码为 500 时:

Internal Server Error

{
  "message" : "Internal error",
  "code" : "SVCSTG.CCE-ADDONMGR.500"
}

状态码

状态码

描述

200

OK

500

Internal Server Error

错误码

请参见错误码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!非常感谢您的反馈,我们会继续努力做到更好!
反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问