本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# updateCluster
<a name="update-cluster"></a>

更新集群。

**Topics**
+ [请求语法](#update-cluster-request)
+ [请求正文](#update-cluster-request-body)
+ [响应语法](#update-cluster-response)
+ [响应正文](#update-cluster-response-body)
+ [示例](#update-cluster-example)

## 请求语法
<a name="update-cluster-request"></a>

```
PUT /v3/clusters/{{{clusterName}}}
{
  "clusterConfiguration": "string",
  "dryrun": boolean,
  "forceUpdate": boolean,
  "region": "string",
  "suppressValidators": "string",
  "validationFailureLevel": "string"
}
```

## 请求正文
<a name="update-cluster-request-body"></a>

**clusterConfiguration**  
集群配置作为 YAML 文档。  
必需：是

**clusterName**  
集群的名称。  
类型：字符串。  
必需：是

**dryrun**  
如果设置为 `true`，则仅执行请求验证而不创建任何资源。使用此参数可验证集群配置和更新要求。默认值为 `false`。  
类型：布尔值  
必需：否

**forceUpdate**  
如果设置为 `true`，则忽略更新验证错误并强制更新。默认值为 `false`。  
类型：布尔值  
必需：否

**region**  
 AWS 区域 集群所在的。  
类型：字符串  
必需：否

**suppressValidators**  
标识一个或多个要禁止的配置验证器。  
类型：字符串  
格式：`(ALL|type:[A-Za-z0-9]+)`  
必需：否  
有效值示例：`currentValue`、`requestedValue`、`message`

**validationFailureLevel**  
导致更新失败的最低验证级别。  
类型：字符串  
有效值：`INFO | WARNING | ERROR`  
必需：否

## 响应语法
<a name="update-cluster-response"></a>

```
{
  "cluster": {
    "clusterName": "string",
    "region": "string",
    "version": "string",
    "cloudformationStackArn": "string",
    "cloudformationStackStatus": "UPDATE_IN_PROGRESS",
    "clusterStatus": "UPDATE_IN_PROGRESS",
    "scheduler": {
      "type": "string",
      "metadata": {
        "name": "string",
        "version": "string"
      }
    }
  },
  "validationMessages": [
    {
      "id": "string",
      "type": "string",
      "level": "INFO",
      "message": "string"
    }
  ],
  "changeSet": [
    {
      "parameter": "string",
      "currentValue": "string",
      "requestedValue": "string"
    }
  ]
}
```

## 响应正文
<a name="update-cluster-response-body"></a>

**changeSet**  
集群更新的更改集。    
**currentValue**  
要更新的参数的当前值。  
类型：字符串  
**参数**  
要更新的参数。  
类型：字符串  
**requestedValue**  
要更新的参数的请求值。  
类型：字符串

**cluster**    
**cloudformationStackArn**  
主 CloudFormation 堆栈的亚马逊资源名称 (ARN)。  
类型：字符串  
**cloudformationStackStatus**  
堆 CloudFormation 栈状态。  
类型：字符串  
有效值：`CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | ROLLBACK_IN_PROGRESS | ROLLBACK_FAILED | ROLLBACK_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_COMPLETE_CLEANUP_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_ROLLBACK_IN_PROGRESS | UPDATE_ROLLBACK_FAILED | UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS | UPDATE_ROLLBACK_COMPLETE`  
**clusterName**  
集群的名称。  
类型：字符串  
**clusterStatus**  
集群状态。  
类型：字符串  
有效值：`CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_FAILED`  
**区域**  
 AWS 区域 在其中创建集群。  
类型：字符串  
**scheduler**    
**metadata**  
调度器元数据。    
**名称**  
调度器的名称。  
类型：字符串  
**version**  
调度器版本。  
类型：字符串  
**type**  
调度器类型。  
类型：字符串

**version**  
AWS ParallelCluster 用于创建集群的版本。  
类型：字符串

**validationMessages**  
验证级别低于 `validationFailureLevel` 的消息的列表。消息列表是在配置验证期间收集的。    
**id**  
验证器的 ID。  
类型：字符串  
**level**  
验证级别。  
类型：字符串  
有效值：`INFO | WARNING | ERROR`  
**message**  
验证消息。  
类型：字符串  
**type**  
验证器的类型。  
类型：字符串

## 示例
<a name="update-cluster-example"></a>

------
#### [ Python ]

**请求**

```
$ update_cluster({{cluster_name_3x}}, {{path/config-file.yaml}})
```

**200 响应**

```
{
  'change_set': [
    {
      'current_value': '10',
      'parameter': 'Scheduling.SlurmQueues[queue1].ComputeResources[t2micro].MaxCount',
      'requested_value': '15'
    }
  ],
  'cluster': {
    'cloudformation_stack_arn': 'arn:aws:cloudformation:us-east-1:123456789012:stack/test-api-cluster/e0462730-50b5-11ed-99a3-0a5ddc4a34c7',
    'cloudformation_stack_status': 'UPDATE_IN_PROGRESS',
    'cluster_name': 'cluster-3x',
    'cluster_status': 'UPDATE_IN_PROGRESS',
    'region': 'us-east-1',
    'scheduler': {
      'type': 'slurm'
    },
    'version': '3.2.1'
  }
}
```

------