翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# 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 リソースネーム (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`  
**スケジューラ**    
**metadata**  
スケジューラのメタデータ。    
**名前**  
スケジューラの名前。  
タイプ: 文字列  
**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'
      },
      ...
   ]
}
```

------