

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

# createCluster
<a name="create-cluster"></a>

在 中建立受管叢集 AWS 區域。

**Topics**
+ [請求語法](#create-cluster-request)
+ [請求內文](#create-cluster-request-body)
+ [回應語法](#create-cluster-response)
+ [回應內文](#create-cluster-response-body)
+ [範例](#create-cluster-example)

## 請求語法
<a name="create-cluster-request"></a>

```
POST /v3/clusters
{
  "clusterName": "string",
  "clusterConfiguration": "string",
  "dryrun": boolean,
  "region": "string",
  "rollbackOnFailure", boolean,
  "suppressValidators": [ "string" ],
  "validationFailureLevel": "string"
}
```

## 請求內文
<a name="create-cluster-request-body"></a>

**clusterConfiguration**  
叢集組態做為 YAML 文件。  
類型：字串  
必要：是

**clusterName**  
要建立的叢集名稱。  
名稱必須以字母字元開頭。名稱最多可有 60 個字元。如果啟用Slurm會計，名稱最多可有 40 個字元。  
類型：字串  
必要：是

**dryrun**  
如果設為 `true`，則只會執行請求驗證，但不會建立任何資源。使用此參數來驗證叢集組態。預設值為 `false`。  
類型：布林值  
必要：否

**region**  
 AWS 區域 叢集所在的 。  
類型：字串  
必要：否

**rollbackOnFailure**  
如果設為 `true`，則叢集堆疊復原會在叢集無法建立時發生。預設值為 `true`。  
類型：布林值  
必要：否

**suppressValidators**  
識別要隱藏的一或多個組態驗證程式。  
類型：字串清單  
格式：`(ALL|type:[A-Za-z0-9]+)`  
必要：否

**validationFailureLevel**  
導致叢集建立失敗的最低驗證層級。預設值為 `ERROR`。  
類型：字串  
有效值：`INFO | WARNING | ERROR`  
必要：否

## 回應語法
<a name="create-cluster-response"></a>

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

## 回應內文
<a name="create-cluster-response-body"></a>

**clusterName**  
叢集的名稱。  
類型：字串

**cloudformationStackArn**  
主要 CloudFormation 堆疊的 Amazon Resource Name (ARN)。  
類型：字串

**cloudformationStackStatus**  
類型：字串  
有效值：`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`

**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 版本。  
類型：字串

**validation\_messages**  
驗證層級低於 的訊息清單`validationFailureLevel`。訊息清單會在組態驗證期間收集。    
**id**  
驗證器的 ID。  
類型：字串  
**level**  
類型：字串  
有效值：`INFO | WARNING | ERROR`  
**message**  
驗證訊息。  
類型：字串  
**type**  
驗證器的類型。  
類型：字串

## 範例
<a name="create-cluster-example"></a>

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

**請求**

```
$ create_cluster({{cluster_name_3x}}, {{cluster-config.yaml}})
```

**200 個回應**

```
{
  "cluster": {
    "cloudformation_stack_arn": "arn:aws:cloudformation:us-east-1:123456789012:stack/cluster-3x/e0462730-50b5-11ed-99a3-0a5ddc4a34c7",
    "cloudformation_stack_status": "CREATE_IN_PROGRESS",
    "cluster_name": "cluster-3x",
    "cluster_status": "CREATE_IN_PROGRESS",
    "region": "us-east-1",
    "scheduler": {
      "type": "slurm"
    },
    "version": "3.2.1"
  }
}
```

------