调用DescribeClusterAddonsUpgradeStatus同时查询多个组件的升级状态。

调试

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

请求语法

GET /clusters/ClusterId/components/upgradestatus?componentIds=["String"] HTTP/1.1
Content-Type:application/json

请求参数

表 1. 请求Path参数
参数名称 类型 是否必选 示例 说明
ClusterId String 是 c23421cfa74454bc8b37163fd19af****

集群ID。
表 2. 请求Query参数
参数名称 类型 是否必选 示例 说明
componentIds Array of String 是 metric-server

组件名称。

响应体语法

HTTP/1.1 200 OK
Content-Type:application/json

{
  "key" : {
    "addon_info" : {
      "component_name" : "String",
      "version" : "String",
      "ready_to_upgrade" : "String"
    },
    "tasks" : {
      "created_at" : "String",
      "finished_at" : "String",
      "status" : "String",
      "is_canceled" : Boolean
    }
  }
}

响应参数

表 3. 响应Body参数
参数名称 类型 示例 说明
Map

返回数据体。
Object

组件升级状态详情。
addon_info Object

组件信息。
component_name String cloud-controller-manager

组件名称。
version String v1.9.3.340-g9830b58-aliyun

组件当前版本。
ready_to_upgrade String true

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

  • true：满足升级条件。
  • false：不满足升级条件。
tasks Object

升级任务详情。
created_at String 2020-12-28T17:00:50Z

任务开始时间。
finished_at String 2020-12-28T17:05:36Z

任务完成时间。
status String Success

升级任务状态。取值：

  • Upgrading：升级中。
  • Success：成功。
  • Failed：失败。
  • Running：安装中。
  • Paused：暂停中。
  • Canceled：已取消。
is_canceled Boolean false

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

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

查询集群组件升级状态示例

请求示例

GET /clusters/c23421cfa74454bc8b37163fd19af****/components/upgradestatus?componentIds=["metric-server"] HTTP/1.1
Host:cs.aliyuncs.com
Content-Type:application/json

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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
    }
  }
}

错误码

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