文档

DescribeClusterAddonsUpgradeStatus - 查询集群组件升级状态

更新时间:
目前该API接口已标记为弃用,推荐使用替代API:CS(2015-12-15) - ListClusterAddonInstancesCS(2015-12-15) - GetClusterAddonInstance

根据组件名称查询该组件升级状态。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cs:DescribeClusterAddonsUpgradeStatusRead
  • Cluster
    acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}

请求语法

GET /clusters/{ClusterId}/components/upgradestatus

请求参数

名称类型必填描述示例值
ClusterIdstring

集群 ID。

c23421cfa74454bc8b37163fd19af****
componentIdsarray

组件名称列表。

string

组件名称。

metric-server

返回参数

名称类型描述示例值
object

返回数据体。

object

组件升级状态详情。

addon_infoobject

组件信息。

component_namestring

组件名称。

cloud-controller-manager
versionstring

组件当前版本。

v1.9.3.340-g9830b58-aliyun
ready_to_upgradestring

组件是否满足升级条件。取值:

  • true:满足升级条件。
  • false:不满足升级条件。
true
tasksobject

升级任务详情。

created_atstring

任务开始时间。

2020-12-28T17:00:50Z
finished_atstring

任务完成时间。

2020-12-28T17:05:36Z
statusstring

升级任务状态。取值:

  • Upgrading:升级中。
  • Success:成功。
  • Failed:失败。
  • Running:安装中。
  • Paused:暂停中。
  • Canceled:已取消。
Success
is_canceledboolean

升级任务是否被取消。取值:

  • true:任务被取消。
  • false:任务未被取消。
false

示例

正常返回示例

JSON格式

{
  "key": {
    "addon_info": {
      "component_name": "cloud-controller-manager",
      "version": "v1.9.3.340-g9830b58-aliyun",
      "ready_to_upgrade": "true"
    },
    "tasks": {
      "created_at": "2020-12-28T17:00:50Z",
      "finished_at": "2020-12-28T17:05:36Z",
      "status": "Success",
      "is_canceled": false
    }
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-01-12OpenAPI 变更为 deprecated,即将下线看变更集
变更项变更内容
API 弃用说明(deprecated)OpenAPI 变更为 deprecated,即将下线
  • 本页导读 (1)