本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# 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**  
要更新的參數請求值。  
類型：字串

**叢集**    
**cloudformationStackArn**  
主要 CloudFormation 堆疊的 Amazon Resource Name (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`  
**region**  
建立叢集 AWS 區域 的 。  
類型：字串  
**排程器**    
**中繼資料**  
排程器中繼資料。    
**name**  
排程器的名稱。  
類型：字串  
**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'
  }
}
```

------