文档首页 > > API参考> API> 插件管理> 更新AddonInstance

更新AddonInstance

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

功能介绍

更新插件实例的功能。

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

调试

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

URI

PUT /api/v3/addons/{id}

表1 路径参数

参数

是否必选

参数类型

描述

id

String

插件实例id

最小长度:1

最大长度:255

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

消息体的类型(格式)

枚举值:

  • application/json;charset=utf-8

  • application/json

X-Auth-Token

String

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

最大长度:16384

表3 请求Body参数

参数

是否必选

参数类型

描述

kind

String

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

缺省值:Addon

apiVersion

String

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

缺省值:v3

metadata

Metadata object

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

spec

InstanceRequestSpec object

spec是集合类的元素类型,内容为插件实例安装/升级的具体请求信息

表4 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

创建时间

表5 InstanceRequestSpec

参数

是否必选

参数类型

描述

version

String

待安装、升级插件的具体版本版本号,例如1.0.0

clusterID

String

集群id

values

Object

插件模板安装参数(各插件不同)

addonTemplateName

String

待安装插件模板名称,如coredns

表6 values

参数

是否必选

参数类型

描述

-

Map<String,String>

插件模板的具体安装参数

响应参数

状态码为 200 时:

表7 响应Body参数

参数

参数类型

描述

kind

String

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

缺省值:Addon

apiVersion

String

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

缺省值:v3

metadata

Metadata object

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

spec

InstanceSpec object

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

status

Status object

插件实例状态

表8 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

创建时间

表9 InstanceSpec

参数

参数类型

描述

clusterID

String

集群id

version

String

插件模板版本号,如1.0.0

addonTemplateName

String

插件模板名称,如coredns

addonTemplateType

String

插件模板类型

addonTemplateLogo

String

插件logo

最大长度:200

addonTemplateLabels

Array of strings

插件模板所属类型

description

String

插件模板描述

values

Object

插件模板安装参数(各插件不同)

表10 values

参数

参数类型

描述

-

Map<String,String>

插件模板的具体安装参数

表11 Status

参数

参数类型

描述

status

String

插件实例状态

枚举值:

  • installing

  • upgrading

  • failed

  • running

reason

String

插件安装失败原因

message

String

安装错误详情

targetVersions

Array of strings

此插件版本,支持升级的集群版本

currentVersion

Versions object

当前插件实例使用的具体插件版本信息

表12 Versions

参数

参数类型

描述

version

String

插件版本号

input

Object

插件安装参数

stable

Boolean

是否为稳定版本

translate

Object

供界面使用的翻译信息

supportVersions

Array of SupportVersions objects

支持集群版本号

creationTimestamp

String

创建时间

updateTimestamp

String

更新时间

表13 SupportVersions

参数

参数类型

描述

clusterType

String

支持的集群类型

clusterVersion

Array of strings

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

请求示例

{
  "kind" : "Addon",
  "apiVersion" : "v3",
  "metadata" : {
    "annotations" : {
      "addon.upgrade/type" : "upgrade"
    }
  },
  "spec" : {
    "addonTemplateName" : "autoscaler",
    "clusterID" : "ff3c18de-d9fe-11ea-ae03-0255ac100449",
    "values" : [ {
      "basic" : ""
    } ]
  },
  "version" : "1.17.2"
}

响应示例

状态码为 200 时:

OK

{
  "kind" : "Addon",
  "apiVersion" : "v3",
  "metadata" : {
    "uid" : "24b23108-55c0-11e9-926f-0255ac101a31",
    "name" : "gpu-beta",
    "creationTimestamp" : "2019-04-03T03:25:34Z",
    "updateTimestamp" : "2019-04-03T03:25:34Z"
  },
  "spec" : {
    "clusterID" : "0c0e4a63-5539-11e9-95f7-0255ac10177e",
    "version" : "1.0.0",
    "addonTemplateName" : "gpu-beta",
    "addonTemplateType" : "helm",
    "addonTemplateLogo" : "",
    "addonTemplateLabels" : [ "Accelerator" ],
    "description" : "A device plugin for nvidia.com/gpu resource on nvidia driver",
    "values" : {
      "basic" : {
        "rbac_enabled" : true,
        "swr_addr" : "100.125.6.246:20202",
        "swr_user" : "hwofficial"
      }
    }
  },
  "status" : {
    "status" : "installing",
    "Reason" : "",
    "message" : "",
    "currentVersion" : {
      "version" : "1.0.0",
      "input" : {
        "basic" : {
          "swr_addr" : "100.125.6.246:20202",
          "swr_user" : "hwofficial"
        },
        "parameters" : { }
      },
      "stable" : true,
      "translate" : {
        "en_US" : {
          "addon" : {
            "changeLog" : "A device plugin for nvidia.com/gpu resource on nvidia driver",
            "description" : "A device plugin for nvidia.com/gpu resource on nvidia driver"
          }
        },
        "zh_CN" : {
          "addon" : {
            "changeLog" : "支持容器里使用GPU显卡的设备管理插件,仅支持nvidia驱动",
            "description" : "支持容器里使用GPU显卡的设备管理插件,仅支持nvidia驱动"
          }
        }
      },
      "creationTimestamp" : "2018-10-23T13:14:55Z",
      "updateTimestamp" : "2018-12-07T09:40:24Z"
    }
  }
}

状态码为 500 时:

Internal Server Error

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

状态码

状态码

描述

200

OK

500

Internal Server Error

错误码

请参见错误码

分享:

    相关文档

    相关产品

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

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

*必选

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

字符长度不能超过200

提交反馈 取消

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

智能客服提问云社区提问