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

# 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 堆栈的亚马逊资源名称 (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`

**区域**  
创建 AWS 区域 集群时使用的。  
类型：字符串

**scheduler**    
**metadata**  
调度器元数据    
**名称**  
调度器的名称。  
类型：字符串  
**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"
  }
}
```

------