기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

# 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**  
클러스터의 이름입니다.  
유형: string  
필수 항목 여부: 예

**리전**  
클러스터가 AWS 리전 있는 입니다.  
유형: string  
필수사항: 아니요

## 응답 구문
<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**  
클러스터의 이름입니다.  
유형: string

**cloudformationStackArn**  
메인 CloudFormation 스택의 Amazon 리소스 이름(ARN)입니다.  
유형: string

**cloudformationStackStatus**  
CloudFormation 스택 상태입니다.  
유형: string  
유효값: `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입니다.  
유형: string

**clusterStatus**  
클러스터 상태입니다.  
유형: string  
유효값: `CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_FAILED`

**computeFleetStatus**  
컴퓨팅 플릿 상태입니다.  
유형: string  
유효값: `START_REQUESTED | STARTING | RUNNING | PROTECTED | STOP_REQUESTED | STOPPING | STOPPED | UNKNOWN | ENABLED | DISABLED`

**creationTime**  
클러스터가 생성된 시간의 타임스탬프입니다.  
유형: 날짜/시간

**lastUpdatedTime**  
클러스터가 마지막으로 업데이트된 시간의 타임스탬프입니다.  
유형: 날짜/시간

**리전**  
클러스터가 생성되는 AWS 리전 입니다.  
유형: string

**tags**  
클러스터와 연관된 태그의 목록입니다.    
**키**  
태그 이름입니다.  
유형: string  
**tag**  
태그 값입니다.  
유형: string

**version**  
클러스터를 생성하는 데 사용되는 AWS ParallelCluster 버전입니다.  
유형: string

**failures**  
클러스터 스택이 `CREATE_FAILED` 상태에 있을 때의 실패 목록입니다.    
**failureCode**  
클러스터 스택이 `CREATE_FAILED` 상태에 있을 때의 장애 코드입니다.  
유형: string  
**failureReason**  
클러스터 스택이 `CREATE_FAILED` 상태일 때 오류가 발생하는 이유입니다.  
유형: string

**head\$1node**  
클러스터 헤드 노드입니다.    
**instanceId**  
Amazon EC2 인스턴스 ID입니다.  
유형: string  
**instanceType**  
Amazon EC2 인스턴스 유형  
유형: string  
**launchTime**  
Amazon EC2 인스턴스가 시작된 시간입니다.  
유형: 날짜/시간  
**privateIpAddress**  
클러스터 프라이빗 IP 주소입니다.  
유형: string  
**publicIpAddress**  
클러스터 퍼블릭 IP 주소입니다.  
유형: string  
**state**  
헤드 노드 인스턴스 상태입니다.  
유형: string  
유효값: `pending | running | shutting-down | terminated | stopping | stopped`

**scheduler**    
**metadata**  
스케줄러의 메타데이터입니다.    
**name**  
스케줄러의 이름입니다.  
유형: string  
**version**  
스케줄러의 버전입니다.  
유형: string

**loginNodes**    
status  
로그인 노드 상태입니다.  
유형: string  
유효값: `PENDING | FAILED | ACTIVE`  
address  
로그인 노드 주소입니다.  
유형: string  
poolName  
로그인 노드 풀 이름입니다.  
유형: string  
scheme  
로그인 노드 스키마입니다.  
유형: string  
healthyNodes  
정상 노드 수입니다.  
유형: 정수  
unhealthyNodes  
비정상 노드의 수입니다.  
유형: 정수

**type**  
스케줄러의 유형입니다.  
유형: string

## 예제
<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"
}
```

------