
# 获取集群升级相关信息 - GetClusterUpgradeInfo
#### 功能介绍
获取集群升级相关信息
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-cce/cce_02_0099.html)。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-cce/cce_02_0395.html)。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
 
#### URI
GET /api/v3/projects/{project_id}/clusters/{cluster_id}/upgradeinfo
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|:---|:---|:---|:---|
| project_id | 是    | String | **参数解释：** 项目ID，获取方式请参见[如何获取接口URI中参数](https://support.huaweicloud.com/api-cce/cce_02_0271.html)。 **约束限制：** 不涉及 **取值范围：** 账号的项目ID **默认取值：** 不涉及 |
| cluster_id | 是    | String | **参数解释：** 集群ID，获取方式请参见[如何获取接口URI中参数](https://support.huaweicloud.com/api-cce/cce_02_0271.html)。 **约束限制：** 不涉及 **取值范围：** 集群ID **默认取值：** 不涉及    |
   
#### 请求参数
无
#### 响应参数
**状态码：200**
表2响应Body参数 
| 参数         | 参数类型                                                                           | 描述                                                                                                                                                                               |
|:---|:---|:---|
| kind       | String                                                                         | **参数解释：** 类型 **取值范围：** 不涉及                            |
| apiVersion | String                                                                         | **参数解释：** API版本 **取值范围：** 不涉及                         |
| metadata   | [Metadata] object                   | **参数解释：** 基本信息，为集合类的元素类型，包含一组由不同名称定义的属性 **取值范围：** 不涉及 |
| spec       | [UpgradeInfoSpec] object     | **参数解释：** 升级配置相关信息 **取值范围：** 不涉及                      |
| status     | [UpgradeInfoStatus] object | **参数解释：** 升级状态信息 **取值范围：** 不涉及                        |
   
 表3Metadata 
| 参数                | 参数类型                 | 描述                                                                                                                                                                                 |
|:---|:---|:---|
| uid               | String               | **参数解释**： 唯一id标识 **取值范围**： 不涉及                          |
| name              | String               | **参数解释**： 资源名称 **取值范围**： 不涉及                            |
| labels            | Map\<String,String\> | **参数解释**： 资源标签，key/value对格式，接口保留字段，填写不会生效 **取值范围**： 不涉及 |
| annotations       | Map\<String,String\> | **参数解释**： 资源注解，由key/value组成 **取值范围**： 不涉及               |
| updateTimestamp   | String               | **参数解释**： 更新时间 **取值范围**： 不涉及                            |
| creationTimestamp | String               | **参数解释**： 创建时间 **取值范围**： 不涉及                            |
   
 表4UpgradeInfoSpec 
| 参数                  | 参数类型                                                                               | 描述                                                                                                                                                          |
|:---|:---|:---|
| lastUpgradeInfo     | [UpgradeInfoStatus] object     | **参数解释：** 上次集群升级信息 **取值范围：** 不涉及 |
| versionInfo         | [UpgradeVersionInfo] object   | **参数解释：** 版本信息 **取值范围：** 不涉及     |
| upgradeFeatureGates | [UpgradeFeatureGates] object | **参数解释：** 集群升级特性开关 **取值范围：** 不涉及 |
   
 表5UpgradeVersionInfo 
| 参数             | 参数类型             | 描述                                                                                                                                                                  |
|:---|:---|:---|
| release        | String           | **参数解释：** 正式版本号，如：v1.19.10 **取值范围：** 不涉及 |
| patch          | String           | **参数解释：** 补丁版本号，如r0 **取值范围：** 不涉及        |
| suggestPatch   | String           | **参数解释：** 推荐升级的目标补丁版本号，如r0 **取值范围：** 不涉及 |
| targetVersions | Array of strings | **参数解释：** 升级目标版本集合 **取值范围：** 不涉及         |
   
 表6UpgradeFeatureGates 
| 参数                   | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|:---|:---|:---|
| supportUpgradePageV4 | Boolean | **参数解释：** 集群升级Console界面是否支持V4版本，该字段一般由CCE Console使用。 **取值范围：** - true：支持V4版本   - false：不支持V4版本    |
   
 表7UpgradeInfoStatus 
| 参数             | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|:---|:---|:---|
| phase          | String | **参数解释：** 升级任务状态 **取值范围：** - Init：初始化   - Running：运行中   - Pause：暂停   - Success：成功   - Failed：失败    |
| progress       | String | **参数解释：** 升级任务进度 **取值范围：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| completionTime | String | **参数解释：** 升级任务结束时间 **取值范围：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
   
#### 请求示例
无
#### 响应示例
**状态码：200**
表示获取集群升级相关信息成功。
```
{
  "kind" : "UpgradeInfo",
  "apiVersion" : "v3",
  "metadata" : { },
  "spec" : {
    "lastUpgradeInfo" : {
      "phase" : "Success",
      "completionTime" : "2023-11-25 11:18:54.478926 +0800 CST"
    },
    "versionInfo" : {
      "release" : "v1.27.2",
      "patch" : "r0",
      "suggestPatch" : "r0",
      "targetVersions" : [ "v1.27.3-r0" ]
    },
    "upgradeFeatureGates" : {
      "supportUpgradePageV4" : true
    }
  },
  "status" : {
    "phase" : "Success",
    "completionTime" : "2023-11-25 11:18:54.478926 +0800 CST"
  }
}
```
#### 状态码
| 状态码 | 描述              |
|:---|:---|
| 200 | 表示获取集群升级相关信息成功。 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-cce/ErrorCode.html)。
