
# 延期自动升级计划 - UpdateAutopilotUpgradePlan
#### 功能介绍
该API用于延期集群自动升级计划。
#### 调用方法
请参见[如何调用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:upgrade | Write | cluster \*  | - g:EnterpriseProjectId   - g:ResourceTag/\<tag-key\>    | -  | -      |
     
  
 
#### URI
PUT /autopilot/v3/projects/{project_id}/clusters/{cluster_id}/upgradeplans/{upgrade_plan_id}
表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 **默认取值：** 不涉及     |
| upgrade_plan_id | 是    | String | 集群自动升级计划ID                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
   
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|:---|:---|:---|:---|
| Content-Type | 是    | String | **参数解释：** 消息体的类型（格式），默认为application/json，有其他取值时会在具体接口中专门说明。 **约束限制：** GET方法不做校验 **默认取值：** 不涉及                                                                            |
| X-Auth-Token | 是    | String | **参数解释：** 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值，获取方式请参见[获取token](https://support.huaweicloud.com/api-cce-autopilot/cce_02_0004.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 |
   
表3请求Body参数 
| 参数        | 是否必选 | 参数类型   | 描述                                 |
|:---|:---|:---|:---|
| notBefore | 是    | String | 新的自动升级计划启动时间，必须早于notBeforeDeadline |
   
#### 响应参数
**状态码：200**
表4响应Body参数 
| 参数         | 参数类型                                                                                | 描述                             |
|:---|:---|:---|
| kind       | String                                                                              | API类型，固定值"UpgradePlan"，该值不可修改。 |
| apiVersion | String                                                                              | API版本，固定值"v3"，该值不可修改。          |
| metadata   | [Metadata] object                   | 自动升级计划的元数据信息                   |
| spec       | [UpgradePlanSpec] object     | 自动升级计划主体                       |
| status     | [UpgradePlanStatus] object | 自动升级计划的当前状态                    |
   
 表5Metadata 
| 参数                | 参数类型                 | 描述                                                                                                                                                                                                                                                                                                                                                                                                              |
|:---|:---|:---|
| uid               | String               | **参数解释**： 唯一id标识 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及                            |
| name              | String               | **参数解释**： 资源名称 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及                             |
| labels            | Map\<String,String\> | **参数解释**： 资源标签，key/value对格式，接口保留字段，填写不会生效 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 |
| annotations       | Map\<String,String\> | **参数解释**： 资源注解，由key/value组成 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及               |
| updateTimestamp   | String               | **参数解释**： 更新时间 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及                        |
| creationTimestamp | String               | **参数解释**： 创建时间 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及                        |
   
 表6UpgradePlanSpec 
| 参数                | 参数类型   | 描述                                       |
|:---|:---|:---|
| clusterID         | String | 集群ID                                     |
| clusterVersion    | String | 当前集群版本                                   |
| targetVersion     | String | 本次集群升级的目标版本                              |
| notBefore         | String | 自动升级计划的最早时间（UTC时间），需要早于notBeforeDeadline |
| notAfter          | String | 自动升级计划的最晚时间（UTC时间）                       |
| notBeforeDeadline | String | 自动升级计划开始的截止时间（UTC时间）                     |
   
 表7UpgradePlanStatus 
| 参数    | 参数类型   | 描述       |
|:---|:---|:---|
| phase | String | 自动升级计划状态 |
   
#### 请求示例
延期自动升级计划
```
PUT /api/v3/projects/{project_id}/clusters/{cluster_id}/upgradeplans/{upgrade_plan_id}
{
  "notBefore" : "2025-01-06 16:00:00 +0000 UTC"
}
```
#### 响应示例
**状态码：200**
表示在指定集群下延期自动升级计划成功。
```
{
  "kind" : "UpgradePlan",
  "apiVersion" : "v3",
  "metadata" : {
    "uid" : "5ddfddfe-87db-11ec-b5e5-0255ac111914"
  },
  "spec" : {
    "clusterID" : "b4b9e60f-8aa2-11ee-af09-0255ac10004f",
    "currentVersion" : "v1.27.6-r0",
    "targetVersion" : "v1.27.9-r0",
    "notBefore" : "2025-01-06 16:00:00 +0000 UTC",
    "notAfter" : "2025-01-06 20:00:00 +0000 UTC",
    "notBeforeDeadline" : "2025-01-30 20:00:00 +0000 UTC"
  },
  "status" : {
    "phase" : "Pending"
  }
}
```
#### 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.*;
  import java.time.LocalDate;
  import java.time.format.DateTimeFormatter;
  public class UpdateAutopilotUpgradePlanSolution {
      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();
          UpdateAutopilotUpgradePlanRequest request = new UpdateAutopilotUpgradePlanRequest();
          request.withClusterId("{cluster_id}");
          request.withUpgradePlanId("{upgrade_plan_id}");
          DelayUpgradePlanRequestBody body = new DelayUpgradePlanRequestBody();
          body.withNotBefore(LocalDate.parse("2025-01-06 16:00:00 +0000 UTC", DateTimeFormatter.ofPattern("yyyy-MM-dd")));
          request.withBody(body);
          try {
              UpdateAutopilotUpgradePlanResponse response = client.updateAutopilotUpgradePlan(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 = UpdateAutopilotUpgradePlanRequest()
          request.cluster_id = "{cluster_id}"
          request.upgrade_plan_id = "{upgrade_plan_id}"
          request.body = DelayUpgradePlanRequestBody(
              not_before="2025-01-06 16:00:00 +0000 UTC"
          )
          response = client.update_autopilot_upgrade_plan(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.UpdateAutopilotUpgradePlanRequest{}
  request.ClusterId = "{cluster_id}"
  request.UpgradePlanId = "{upgrade_plan_id}"
  request.Body = &model.DelayUpgradePlanRequestBody{
  NotBefore: "2025-01-06 16:00:00 +0000 UTC",
  }
  response, err := client.UpdateAutopilotUpgradePlan(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=UpdateAutopilotUpgradePlan)的代码示例页签，可生成自动对应的SDK代码示例。
#### 状态码
| 状态码 | 描述                  |
|:---|:---|
| 200 | 表示在指定集群下延期自动升级计划成功。 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-cce-autopilot/ErrorCode.html)。
