listClusters - AWS ParallelCluster

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

listClusters

检索现有集群的列表。

请求语法

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

请求正文

clusterStatus

按集群状态筛选。默认为所有集群。

类型:字符串

有效值:CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | UPDATE_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_FAILED

必需:否

nextToken

用于分页请求的令牌。

类型:字符串

必需:否

region

集 AWS 区域 群中的。

类型:字符串

必需:否

响应语法

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

响应正文

clusters
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

scheduler
metadata

调度器元数据。

name

调度器的名称。

类型:字符串

版本

调度器版本。

类型:字符串

type

调度器的类型。

类型:字符串

region

创建 AWS 区域 集群时使用的。

类型:字符串

版本

用于创建集群的 AWS ParallelCluster 版本。

类型:字符串

nextToken

用于分页请求的令牌。

类型:字符串

示例

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' }, ... ] }