
# 获取集群升级相关信息 - ShowAutopilotClusterUpgradeInfo
#### 功能介绍
获取集群升级相关信息
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-cce-autopilot/cce_02_0099.html)。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-cce-autopilot/cce_02_0327.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                    | 访问级别 | 资源类型（\*为必须） | 条件键                                                                                                                                                                                                                                                                                                                                                                                                                                                               | 别名                                                                                                                                                                           | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | cce:cluster:getCluster | Read | cluster \*  | - g:ResourceTag/\<tag-key\>   - g:EnterpriseProjectId    | - cce:cluster:get   | -      |
     
  
 
#### URI
GET /autopilot/v3/projects/{project_id}/clusters/{cluster_id}/upgradeinfo
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|:---|:---|:---|:---|
| project_id | 是    | String | **参数解释：** 项目ID，获取方式请参见[如何获取接口URI中参数](https://support.huaweicloud.com/api-cce-autopilot/cce_02_0271.html)。 **约束限制：** 不涉及 **取值范围：** 账号的项目ID **默认取值：** 不涉及 |
| cluster_id | 是    | String | **参数解释：** 集群ID，获取方式请参见[如何获取接口URI中参数](https://support.huaweicloud.com/api-cce-autopilot/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使用。 |
   
 表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"
  }
}
```
#### SDK代码示例
SDK代码示例如下。
- [Java]
  ```
  package com.huaweicloud.sdk.test;
  import com.huaweicloud.sdk.core.auth.ICredential;
  import com.huaweicloud.sdk.core.auth.BasicCredentials;
  import com.huaweicloud.sdk.core.exception.ConnectionException;
  import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
  import com.huaweicloud.sdk.core.exception.ServiceResponseException;
  import com.huaweicloud.sdk.cce.v3.region.CceRegion;
  import com.huaweicloud.sdk.cce.v3.*;
  import com.huaweicloud.sdk.cce.v3.model.*;
  public class ShowAutopilotClusterUpgradeInfoSolution {
      public static void main(String[] args) {
          // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
          // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
          String ak = System.getenv("CLOUD_SDK_AK");
          String sk = System.getenv("CLOUD_SDK_SK");
          String projectId = "{project_id}";
          ICredential auth = new BasicCredentials()
                  .withProjectId(projectId)
                  .withAk(ak)
                  .withSk(sk);
          CceClient client = CceClient.newBuilder()
                  .withCredential(auth)
                  .withRegion(CceRegion.valueOf("<YOUR REGION>"))
                  .build();
          ShowAutopilotClusterUpgradeInfoRequest request = new ShowAutopilotClusterUpgradeInfoRequest();
          request.withClusterId("{cluster_id}");
          try {
              ShowAutopilotClusterUpgradeInfoResponse response = client.showAutopilotClusterUpgradeInfo(request);
              System.out.println(response.toString());
          } catch (ConnectionException e) {
              e.printStackTrace();
          } catch (RequestTimeoutException e) {
              e.printStackTrace();
          } catch (ServiceResponseException e) {
              e.printStackTrace();
              System.out.println(e.getHttpStatusCode());
              System.out.println(e.getRequestId());
              System.out.println(e.getErrorCode());
              System.out.println(e.getErrorMsg());
          }
      }
  }
  ```
- [Python]
  ```
  # coding: utf-8
  import os
  from huaweicloudsdkcore.auth.credentials import BasicCredentials
  from huaweicloudsdkcce.v3.region.cce_region import CceRegion
  from huaweicloudsdkcore.exceptions import exceptions
  from huaweicloudsdkcce.v3 import *
  if __name__ == "__main__":
      # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
      # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
      ak = os.environ["CLOUD_SDK_AK"]
      sk = os.environ["CLOUD_SDK_SK"]
      projectId = "{project_id}"
      credentials = BasicCredentials(ak, sk, projectId)
      client = CceClient.new_builder() \
          .with_credentials(credentials) \
          .with_region(CceRegion.value_of("<YOUR REGION>")) \
          .build()
      try:
          request = ShowAutopilotClusterUpgradeInfoRequest()
          request.cluster_id = "{cluster_id}"
          response = client.show_autopilot_cluster_upgrade_info(request)
          print(response)
      except exceptions.ClientRequestException as e:
          print(e.status_code)
          print(e.request_id)
          print(e.error_code)
          print(e.error_msg)
  ```
- [Go]
  ```
  package main
  import (
  "fmt"
  "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
      cce "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3"
  "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3/model"
      region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3/region"
  )
  func main() {
      // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
      // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
      ak := os.Getenv("CLOUD_SDK_AK")
      sk := os.Getenv("CLOUD_SDK_SK")
      projectId := "{project_id}"
      auth := basic.NewCredentialsBuilder().
          WithAk(ak).
          WithSk(sk).
          WithProjectId(projectId).
          Build()
      client := cce.NewCceClient(
          cce.CceClientBuilder().
              WithRegion(region.ValueOf("<YOUR REGION>")).
              WithCredential(auth).
              Build())
      request := &model.ShowAutopilotClusterUpgradeInfoRequest{}
  request.ClusterId = "{cluster_id}"
  response, err := client.ShowAutopilotClusterUpgradeInfo(request)
  if err == nil {
          fmt.Printf("%+v\n", response)
      } else {
          fmt.Println(err)
      }
  }
  ```
- [更多]
  更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CCE/sdk?api=ShowAutopilotClusterUpgradeInfo)的代码示例页签，可生成自动对应的SDK代码示例。
#### 状态码
| 状态码 | 描述              |
|:---|:---|
| 200 | 表示获取集群升级相关信息成功。 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-cce-autopilot/ErrorCode.html)。
