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

# deleteCluster
<a name="delete-cluster"></a>

开始删除集群。

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

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

```
DELETE /v3/clusters/{{{clusterName}}}
{
  "region": "string"
}
```

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

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

**区域**  
 AWS 区域 在其中删除集群。  
类型：字符串  
必需：否

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

```
{
   "cluster": {
       "clusterName": "string",
       "region": "string",
       "version": "string",
       "cloudformationStackArn": "string",
       "cloudformationStackStatus": "DELETE_IN_PROGRESS",
       "clusterStatus": "DELETE_IN_PROGRESS",
       "scheduler": {
           "type": "string",
           "metadata": {
               "name": "string",
               "version": "string"
           }
        }
    }
}
```

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

**cluster**  
集群实例列表。    
**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 版本。  
类型：字符串

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

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

**请求**

```
$ delete_cluster({{cluster_name_3x}})
```

**200 响应**

```
{
  "cluster": {
    "cloudformation_stack_arn": "arn:aws:cloudformation:us-east-1:123456789012:stack/cluster_name_3x/16b49540-aee5-11ec-8e18-0ac1d712b241",
    "cloudformation_stack_status": "DELETE_IN_PROGRESS",
    "cluster_name": "cluster_name_3x",
    "cluster_status": "DELETE_IN_PROGRESS",
    "region": "us-east-1",
    "version": "3.2.1"
  }
}
```

------