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

# listClusters
<a name="list-clusters"></a>

擷取現有叢集的清單。

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

## 請求語法
<a name="list-clusters-request"></a>

```
GET /v3/clusters
{
  "clusterStatus": "string",
  "nextToken": "string",
  "region": "string"
}
```

## 請求內文
<a name="list-clusters-request-body"></a>

**clusterStatus**  
依叢集狀態篩選。預設值是所有叢集。  
類型：字串  
有效值：`CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | UPDATE_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_FAILED`  
必要：否

**nextToken**  
下一組結果的字符。  
類型：字串  
必要：否

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

## 回應語法
<a name="list-clusters-response"></a>

```
{
  "nextToken": "string",
  "clusters": [
    {
      "clusterName": "string",
      "region": "string",
      "version": "string",
      "cloudformationStackArn": "string",
      "cloudformationStackStatus": "CREATE_IN_PROGRESS",
      "clusterStatus": "CREATE_IN_PROGRESS",
      "scheduler": {
        "type": "string",
        "metadata": {
          "name": "string",
          "version": "string"
        }
      }
    }
  ]
}
```

## 回應內文
<a name="list-clusters-response-body"></a>

**叢集**    
**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`  
**排程器**    
**中繼資料**  
排程器中繼資料。    
**name**  
排程器的名稱。  
類型：字串  
**version**  
排程器版本。  
類型：字串  
**type**  
排程器的類型。  
類型：字串  
**region**  
建立叢集 AWS 區域 的 。  
類型：字串  
**version**  
用來建立叢集的 AWS ParallelCluster 版本。  
類型：字串

**nextToken**  
可用於擷取下一組結果的字符，或如果沒有其他結果則為 `null`。  
類型：字串

## 範例
<a name="list-clusters-example"></a>

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

**請求**

```
$ list_clusters()
```

**200 個回應**

```
{
  'clusters': 
   [
      {
        'cloudformation_stack_arn': 'arn:aws:cloudformation:us-east-1:123456789012:stack/cluster_name_3x/16b49540-aee5-11ec-8e18-0ac1d712b241',
        'cloudformation_stack_status': 'CREATE_COMPLETE',
        'cluster_name': 'cluster_name_3x',
        'cluster_status': 'CREATE_COMPLETE',
        'region': 'us-east-1',
        'version': '3.2.1'
      },
      ...
   ]
}
```

------