回滚AddonInstance

功能介绍

将插件实例回滚到升级前的版本。只有在当前插件实例版本支持回滚到升级前的版本（status.isRollbackable为true），且插件实例状态为running（运行中）、available（可用）、abnormal（不可用）、upgradeFailed（升级失败）、rollbackFailed（回滚失败）时支持回滚。

URI

POST /api/v3/addons/{id}/operation/rollback

表1 路径参数
参数	是否必选	参数类型	描述
id	是	String	插件实例ID

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值，获取方式请参见获取token。

表3 请求Body参数
参数	是否必选	参数类型	描述
clusterID	是	String	集群ID

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
kind	String	API类型，固定值“Addon”，该值不可修改。
apiVersion	String	API版本，固定值“v3”，该值不可修改。
metadata	AddonMetadata object	基本信息，为集合类的元素类型，包含一组由不同名称定义的属性
spec	InstanceSpec object	spec是集合类的元素类型，内容为插件实例具体信息，实例的详细描述主体部分都在spec中给出
status	AddonInstanceStatus object	插件实例状态

表5 AddonMetadata
参数	参数类型	描述
uid	String	唯一id标识
name	String	插件名称
alias	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 InstanceSpec
参数	参数类型	描述
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>	插件模板安装参数（各插件不同），请根据具体插件模板信息填写安装参数。

表7 AddonInstanceStatus
参数	参数类型	描述
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	插件升级或回滚前的版本

表8 Versions
参数	参数类型	描述
version	String	插件版本号
input	Object	插件安装参数
stable	Boolean	是否为稳定版本
translate	Object	供界面使用的翻译信息
supportVersions	Array of SupportVersions objects	支持集群版本号
creationTimestamp	String	创建时间
updateTimestamp	String	更新时间

表9 SupportVersions
参数	参数类型	描述
clusterType	String	支持的集群类型
clusterVersion	Array of strings	支持的集群版本（正则表达式）

请求示例

{
  "clusterID" : "******"
}

响应示例

状态码： 200

插件实例回滚成功

{
  "kind" : "Addon",
  "apiVersion" : "v3",
  "metadata" : {
    "uid" : "******",
    "name" : "everest",
    "alias" : "everest",
    "creationTimestamp" : "2023-03-15T02:48:01Z",
    "updateTimestamp" : "2023-03-15T04:18:45Z"
  },
  "spec" : {
    "clusterID" : "******",
    "version" : "2.1.16",
    "addonTemplateName" : "everest",
    "addonTemplateType" : "helm",
    "addonTemplateLogo" : "******",
    "addonTemplateLabels" : [ "Storage" ],
    "description" : "Everest is a cloud native container storage system based on CSI, used\nto support cloud storages services for Kubernetes",
    "values" : {
      "basic" : {
        "base_image" : "euleros",
        "bms_url" : "******",
        "cluster_version" : "v1.25",
        "driver_init_image_version" : "2.1.16",
        "ecsEndpoint" : "******",
        "euleros_version" : "2.2.5",
        "everest_image_version" : "2.1.16",
        "evs_url" : "******",
        "iam_url" : "******",
        "ims_url" : "******",
        "obs_url" : "******",
        "platform" : "linux-amd64",
        "rbac_enabled" : true,
        "sfs30_url" : "******",
        "sfs_turbo_url" : "******",
        "sfs_url" : "******",
        "supportHcs" : false,
        "swr_addr" : "******",
        "swr_user" : "******"
      },
      "custom" : {
        "cluster_id" : "******",
        "cluster_version" : "v1.25.3-r0",
        "csi_attacher_detach_worker_threads" : "60",
        "csi_attacher_worker_threads" : "60",
        "default_vpc_id" : "******",
        "disable_auto_mount_secret" : false,
        "enable_node_attacher" : false,
        "flow_control" : { },
        "multiAZEnabled" : false,
        "over_subscription" : "80",
        "project_id" : "******",
        "volume_attaching_flow_ctrl" : "0"
      },
      "flavor" : {
        "category" : [ "CCE", "Turbo" ],
        "description" : "High avaiable",
        "name" : "HA",
        "replicas" : 2,
        "resources" : [ {
          "limitsCpu" : "250m",
          "limitsMem" : "1500Mi",
          "name" : "everest-csi-controller",
          "requestsCpu" : "250m",
          "requestsMem" : "600Mi"
        }, {
          "limitsCpu" : "500m",
          "limitsMem" : "300Mi",
          "name" : "everest-csi-driver",
          "requestsCpu" : "100m",
          "requestsMem" : "300Mi"
        } ]
      },
      "multiAZPreferred" : {
        "podAntiAffinity" : {
          "preferredDuringSchedulingIgnoredDuringExecution" : [ {
            "podAffinityTerm" : {
              "labelSelector" : {
                "matchExpressions" : [ {
                  "key" : "app",
                  "operator" : "In",
                  "values" : [ "everest-csi-controller" ]
                } ]
              },
              "topologyKey" : "topology.kubernetes.io/zone"
            },
            "weight" : 100
          } ]
        }
      },
      "multiAZRequired" : {
        "podAntiAffinity" : {
          "requiredDuringSchedulingIgnoredDuringExecution" : [ {
            "labelSelector" : {
              "matchExpressions" : [ {
                "key" : "app",
                "operator" : "In",
                "values" : [ "everest-csi-controller" ]
              } ]
            },
            "topologyKey" : "topology.kubernetes.io/zone"
          } ]
        }
      },
      "systemAutoInject" : {
        "cluster" : {
          "category" : "CCE",
          "clusterID" : "******",
          "clusterNetworkMode" : "vpc-router",
          "clusterVersion" : "v1.25.3-r0"
        },
        "user" : {
          "projectID" : "******"
        }
      },
      "tolerations" : [ {
        "effect" : "NoExecute",
        "key" : "node.kubernetes.io/not-ready",
        "operator" : "Exists",
        "tolerationSeconds" : 60
      }, {
        "effect" : "NoExecute",
        "key" : "node.kubernetes.io/unreachable",
        "operator" : "Exists",
        "tolerationSeconds" : 60
      } ]
    }
  },
  "status" : {
    "status" : "rollbacking",
    "Reason" : "Rollback to 4",
    "message" : "",
    "targetVersions" : [ "2.1.18", "2.1.19" ],
    "isRollbackable" : false,
    "previousVersion" : "2.1.19",
    "currentVersion" : {
      "version" : "2.1.16",
      "input" : {
        "basic" : {
          "bms_url" : "******",
          "driver_init_image_version" : "2.1.16",
          "ecsEndpoint" : "******",
          "everest_image_version" : "2.1.16",
          "evs_url" : "******",
          "iam_url" : "******",
          "ims_url" : "******",
          "obs_url" : "******",
          "platform" : "linux-amd64",
          "sfs30_url" : "******",
          "sfs_turbo_url" : "******",
          "sfs_url" : "******",
          "supportHcs" : false,
          "swr_addr" : "******",
          "swr_user" : "******"
        },
        "parameters" : {
          "common" : {
            "defaultVPCId" : 0
          },
          "custom" : {
            "cluster_id" : "",
            "csi_attacher_detach_worker_threads" : "60",
            "csi_attacher_worker_threads" : "60",
            "default_vpc_id" : "",
            "disable_auto_mount_secret" : false,
            "enable_node_attacher" : false,
            "flow_control" : { },
            "multiAZEnabled" : false,
            "over_subscription" : "80",
            "project_id" : "",
            "volume_attaching_flow_ctrl" : "0"
          },
          "flavor1" : {
            "description" : "High avaiable",
            "name" : "HA",
            "replicas" : 2,
            "resources" : [ {
              "limitsCpu" : "250m",
              "limitsMem" : "1500Mi",
              "name" : "everest-csi-controller",
              "requestsCpu" : "250m",
              "requestsMem" : "600Mi"
            }, {
              "limitsCpu" : "500m",
              "limitsMem" : "300Mi",
              "name" : "everest-csi-driver",
              "requestsCpu" : "100m",
              "requestsMem" : "300Mi"
            } ]
          },
          "flavor2" : {
            "description" : "Has only one instance",
            "name" : "Single",
            "replicas" : 1,
            "resources" : [ {
              "limitsCpu" : "250m",
              "limitsMem" : "600Mi",
              "name" : "everest-csi-controller",
              "requestsCpu" : "250m",
              "requestsMem" : "600Mi"
            }, {
              "limitsCpu" : "100m",
              "limitsMem" : "300Mi",
              "name" : "everest-csi-driver",
              "requestsCpu" : "100m",
              "requestsMem" : "300Mi"
            } ]
          },
          "flavor3" : {
            "description" : "custom resources",
            "name" : "custom-resources",
            "replicas" : 2,
            "resources" : [ {
              "limitsCpu" : "250m",
              "limitsMem" : "2000Mi",
              "name" : "everest-csi-controller",
              "requestsCpu" : "250m",
              "requestsMem" : "1500Mi"
            }, {
              "limitsCpu" : "500m",
              "limitsMem" : "300Mi",
              "name" : "everest-csi-driver",
              "requestsCpu" : "100m",
              "requestsMem" : "300Mi"
            } ]
          }
        }
      },
      "stable" : true,
      "translate" : {
        "en_US" : {
          "addon" : {
            "changeLog" : "******",
            "description" : "******"
          },
          "description" : {
            "Parameters.flavor1.description" : "******",
            "Parameters.flavor1.name" : "******",
            "Parameters.flavor2.description" : "******",
            "Parameters.flavor2.name" : "******",
            "Parameters.flavor3.name" : "******"
          }
        },
        "zh_CN" : {
          "addon" : {
            "changeLog" : "******",
            "description" : "******"
          },
          "description" : {
            "Parameters.flavor1.description" : "******",
            "Parameters.flavor1.name" : "******",
            "Parameters.flavor2.description" : "******",
            "Parameters.flavor2.name" : "******",
            "Parameters.flavor3.description" : "******",
            "Parameters.flavor3.name" : "******"
          }
        }
      },
      "supportVersions" : null,
      "creationTimestamp" : "2023-02-21T16:29:02Z",
      "updateTimestamp" : "2023-02-22T06:49:50Z"
    }
  }
}

状态码

状态码	描述
200	插件实例回滚成功

错误码

请参见错误码。

父主题： 插件管理

上一篇：更新AddonInstance

下一篇：删除AddonInstance

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消