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

# 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**  
叢集的名稱。  
類型：字串  
必要：是

**region**  
刪除叢集 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>

**叢集**  
叢集執行個體的清單。    
**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 版本。  
類型：字串

## 範例
<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"
  }
}
```

------