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

# describeCluster
<a name="describe-cluster"></a>

既存のクラスターの詳細情報を取得します。

**Topics**
+ [リクエスト構文](#describe-cluster-request)
+ [リクエスト本文](#describe-cluster-request-body)
+ [レスポンスの構文](#describe-cluster-response)
+ [レスポンス本文](#describe-cluster-response-body)
+ [例](#describe-cluster-example)

## リクエスト構文
<a name="describe-cluster-request"></a>

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

## リクエスト本文
<a name="describe-cluster-request-body"></a>

**clusterName**  
クラスターの名前。  
タイプ: 文字列  
必須: はい

**region**  
クラスター AWS リージョン がある 。  
型: 文字列  
必須: いいえ

## レスポンスの構文
<a name="describe-cluster-response"></a>

**注記**  
`failureReason` が AWS ParallelCluster バージョン 3.5.0 `failures`から に変更されました。

```
{
  "clusterName": "string",
  "region": "string",
  "version": "string",
  "cloudFormationStackStatus": "CREATE_IN_PROGRESS",
  "clusterStatus": "CREATE_IN_PROGRESS",
  "scheduler": {
    "type": "string",
    "metadata": {
      "name": "string",
      "version": "string"
    }
  },
  "cloudformationStackArn": "string",
  "creationTime": "2019-08-24T14:15:22Z",
  "lastUpdatedTime": "2019-08-24T14:15:22Z",
  "clusterConfiguration": {
    "url": "string"
  },
  "computeFleetStatus": "START_REQUESTED",
  "tags": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "headNode": {
    "instanceId": "string",
    "instanceType": "string",
    "launchTime": "2019-08-24T14:15:22Z",
    "privateIpAddress": "string",
    "publicIpAddress": "string",
    "state": "pending"
  },
  "failures": [
    {
      "failureCode": "string",
      "failureReason": "string"
    }
  ],
  "loginNodes": {      
    "status": "string",
    "address": "string",
    "poolName": "string",
    "scheme": "string",
    "healthyNodes": integer,
    "unhealthyNodes": integer
  }
}
```

## レスポンス本文
<a name="describe-cluster-response-body"></a>

**clusterName**  
クラスターの名前。  
タイプ: 文字列

**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`

**clusterConfiguration**    
**url**  
クラスター設定ファイルの URL。  
タイプ: 文字列

**clusterStatus**  
クラスターのステータス。  
タイプ: 文字列  
有効な値: `CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_FAILED`

**computeFleetStatus**  
コンピューティングフリートのステータス。  
タイプ: 文字列  
有効な値: `START_REQUESTED | STARTING | RUNNING | PROTECTED | STOP_REQUESTED | STOPPING | STOPPED | UNKNOWN | ENABLED | DISABLED`

**creationTime**  
クラスターが作成された時刻のタイムスタンプ。  
型: 日時

**lastUpdatedTime**  
クラスターが最後に更新された時刻のタイムスタンプ。  
型: 日時

**region**  
クラスターが作成される AWS リージョン 。  
タイプ: 文字列

**tags**  
クラスターに関連付けられているタグのリスト。    
**キー**  
タグ名。  
タイプ: 文字列  
**tag**  
タグ値。  
タイプ: 文字列

**version**  
クラスターの作成に使用される AWS ParallelCluster バージョン。  
タイプ: 文字列

**エラー**  
クラスタースタックが `CREATE_FAILED` ステータスのときの障害リスト。    
**failureCode**  
クラスタースタックが `CREATE_FAILED` ステータスのときの失敗コード。  
タイプ: 文字列  
**failureReason**  
クラスタースタックが `CREATE_FAILED` ステータスになったときの失敗の理由。  
タイプ: 文字列

**head\$1node**  
クラスターヘッドノード。    
**instanceId**  
Amazon EC2 インスタンス ID。  
タイプ: 文字列  
**instanceType**  
Amazon EC2 インスタンスタイプ  
タイプ: 文字列  
**launchTime**  
EC2 インスタンスの起動時刻。  
型: 日時  
**privateIpAddress**  
クラスターのプライベート IP アドレス。  
タイプ: 文字列  
**publicIpAddress**  
クラスターのパブリック IP アドレス。  
タイプ: 文字列  
**state**  
ヘッドノードのインスタンスステータス。  
タイプ: 文字列  
有効な値: `pending | running | shutting-down | terminated | stopping | stopped`

**スケジューラ**    
**metadata**  
スケジューラのメタデータ。    
**名前**  
スケジューラの名前。  
タイプ: 文字列  
**version**  
スケジューラのバージョン。  
タイプ: 文字列

**loginNodes**    
ステータス  
ログインノードのステータス。  
タイプ: 文字列  
有効な値: `PENDING | FAILED | ACTIVE`  
アドレス  
ログインノードのアドレス。  
タイプ: 文字列  
poolName  
ログインノードのプール名。  
タイプ: 文字列  
scheme  
ログインノードのスキーム。  
タイプ: 文字列  
healthyNodes  
正常なノードの数。  
タイプ: 整数  
unhealthyNodes  
異常なノードの数。  
タイプ: 整数

**type**  
スケジューラタイプ。  
タイプ: 文字列

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

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

**リクエスト**

```
$ describe_cluster(cluster_name_3x)
```

**200 レスポンス**

```
{
  "cloud_formation_stack_status": "CREATE_COMPLETE",
  "cloudformation_stack_arn": "arn:aws:cloudformation:us-east-1:123456789012:stack/cluster_name_3x/16b49540-aee5-11ec-8e18-0ac1d712b241",
  "cluster_configuration": {
    "url": "https://parallelcluster-...."
  },
  "cluster_name": "cluster_name_3x",
  "cluster_status": "CREATE_COMPLETE",
  "compute_fleet_status": "RUNNING",
  "creation_time": datetime.datetime(2022, 3, 28, 22, 19, 9, 661000, tzinfo=tzlocal()),
  "head_node": {
    "instance_id": "i-abcdef01234567890",
    "instance_type": "t2.micro",
    "launch_time": datetime.datetime(2022, 3, 28, 22, 21, 56, tzinfo=tzlocal()),
    "private_ip_address": "172.31.56.3",
    "public_ip_address": "107.23.100.164",
    "state": "running"
  },
  "last_updated_time": datetime.datetime(2022, 3, 28, 22, 19, 9, 661000, tzinfo=tzlocal()),
  "region": "us-east-1",
  "tags": [
    {
      "key": "parallelcluster:version", "value": "3.2.1"
    }
  ],
  "version": "3.2.1"
}
```

------