describeCluster - AWS ParallelCluster

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

describeCluster

取得現有叢集的詳細資訊。

請求語法

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

請求內文

clusterName

叢集的名稱。

類型:字串

必要:是

region

AWS 區域 叢集所在的 。

類型:字串

必要:否

回應語法

注意

failureReason 從 3.5.0 AWS ParallelCluster 版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 } }

回應內文

clusterName

叢集的名稱。

類型:字串

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

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 區域 的 。

類型:字串

標籤

與叢集相關聯的標籤清單。

金錀

標籤名稱。

類型:字串

標籤

標籤值。

類型:字串

version

用來建立叢集的 AWS ParallelCluster 版本。

類型:字串

failures

叢集堆疊處於 CREATE_FAILED 狀態時的失敗清單。

failureCode

叢集堆疊處於 CREATE_FAILED 狀態時的失敗碼。

類型:字串

failureReason

當叢集堆疊處於 CREATE_FAILED 狀態時失敗的原因。

類型:字串

head_node

叢集前端節點。

instanceId

Amazon EC2 執行個體 ID。

類型:字串

instanceType

Amazon EC2 執行個體類型。

類型:字串

launchTime

Amazon EC2 執行個體啟動的時間。

類型:日期時間

privateIpAddress

叢集私有 IP 地址。

類型:字串

publicIpAddress

叢集公有 IP 地址。

類型:字串

state

前端節點執行個體狀態。

類型:字串

有效值:pending | running | shutting-down | terminated | stopping | stopped

排程器
中繼資料

排程器中繼資料。

name

排程器的名稱。

類型:字串

version

排程器版本。

類型:字串

loginNodes
status

登入節點狀態。

類型:字串

有效值:PENDING | FAILED | ACTIVE

address

登入節點地址。

類型:字串

poolName

登入節點集區名稱。

類型:字串

結構描述

登入節點結構描述。

類型:字串

healthyNodes

運作狀態良好的節點數目。

類型:整數

unhealthyNodes

運作狀態不佳的節點數目。

類型:整數

type

排程器類型。

類型:字串

範例

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" }