GetUpgradeStatus - 查询集群升级状态

目前该API接口已标记为弃用,推荐使用替代API:CS(2015-12-15) - DescribeTaskInfo

根据集群ID,查询该集群的升级状态。

调试

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

授权信息

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

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

请求语法

GET /api/v2/clusters/{ClusterId}/upgrade/status HTTP/1.1

请求参数

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

集群 ID。

c106f377e16f34eb1808d6b9362c9****

返回参数

名称类型描述示例值
object

集群升级状态详情。

error_messagestring

集群升级中的错误信息。

subject to actual return
precheck_report_idstring

预检查返回 ID。

be4c8eb72de94d459ea7ace7c811d119
statusstring

集群目前升级的状态。取值:

  • success : 升级成功。
  • fail : 升级失败。
  • pause : 升级暂停。
  • running : 升级进行中。
running
upgrade_stepstring

集群目前升级的阶段。取值:

  • not_start : 暂未开始。
  • prechecking : 预检查中。
  • upgrading: 升级中。
  • pause : 暂停中。
  • success : 升级成功。
prechecking
upgrade_taskobject

升级任务详情。

statusstring

升级任务状态。取值:

  • running: 执行中。
  • Success: 执行成功。
  • Failed: 执行失败。
running
messagestring

升级任务描述信息。

subject to actual return

示例

正常返回示例

JSON格式

{
  "error_message": "subject to actual return",
  "precheck_report_id": "be4c8eb72de94d459ea7ace7c811d119",
  "status": "running",
  "upgrade_step": "prechecking",
  "upgrade_task": {
    "status": "running",
    "message": "subject to actual return"
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-06-18OpenAPI 变更为 deprecated,即将下线查看变更详情