本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
# AWS ParallelCluster API 参考
本节提供每个 AWS ParallelCluster API 操作的描述、语法和用法示例。
**Topics**
+ [buildImage](build-image.md)
+ [createCluster](create-cluster.md)
+ [deleteCluster](delete-cluster.md)
+ [deleteClusterInstances](delete-cluster-instances.md)
+ [deleteImage](delete-image.md)
+ [describeCluster](describe-cluster.md)
+ [describeClusterInstances](describe-cluster-instances.md)
+ [describeComputeFleet](describe-compute-fleet.md)
+ [describeImage](describe-image.md)
+ [getClusterLog活动](get-cluster-log-events.md)
+ [getClusterStack活动](get-cluster-stack-events.md)
+ [getImageLog活动](get-image-log-events.md)
+ [getImageStack活动](get-image-stack-events.md)
+ [listClusters](list-clusters.md)
+ [listClusterLog直播](list-cluster-log-streams.md)
+ [listImageLog直播](list-image-log-streams.md)
+ [listImages](list-images.md)
+ [listOfficialImages](list-official-images.md)
+ [updateCluster](update-cluster.md)
+ [updateComputeFleet](update-compute-fleet.md)
# buildImage
在中创建自定义 AWS ParallelCluster 镜像 AWS 区域。
**Topics**
+ [请求语法](#build-image-request)
+ [请求正文](#build-image-request-body)
+ [响应语法](#build-image-response)
+ [响应正文](#build-image-response-body)
+ [示例](#build-image-example)
## 请求语法
```
POST /v3/images/custom
{
"imageConfiguration": "string",
"imageId": "string",
"dryrun": boolean,
"region": "string",
"rollbackOnFailure": boolean,
"supressValidators": [ "string" ],
"validationFailureLevel": "string"
}
```
## 请求正文
**imageConfiguration**
映像配置作为 YAML 文档。
类型：字符串。
必需：是
**imageId**
要构建的映像的 ID。
类型：字符串。
必需：是
**dryrun**
如果设置为 `true`，则仅执行请求验证而不创建任何资源。使用此参数可验证映像配置。默认值为 `false`。
类型：布尔值
必需：否
**region**
你 AWS 区域 在其中运行命令来构建镜像。
类型：字符串
必需：否
**rollbackOnFailure**
如果设置为 `true`，则在创建映像失败时会回滚映像堆栈。默认值为 `false`。
类型：布尔值
必需：否
**suppressValidators**
标识一个或多个要禁止的配置验证器。
类型：字符串列表
格式：`(ALL|type:[A-Za-z0-9]+)`
必需：否
**validationFailureLevel**
导致映像构建失败的最低验证级别。默认值为 `ERROR`。
类型：字符串
有效值：`INFO | WARNING | ERROR`
必需：否
## 响应语法
```
{
"image": {
"imageId": "string",
"ec2AmiInfo": {
"amiId": "string"
},
"region": "string",
"version": "string",
"cloudformationStackArn": "string",
"imageBuildStatus": "BUILD_IN_PROGRESS",
"cloudformationStackStatus": "CREATE_IN_PROGRESS"
},
"validationMessages": [
{
"id": "string",
"type": "string",
"level": "INFO",
"message": "string"
}
]
}
```
## 响应正文
**image**
**imageId**
映像的 ID。
类型：字符串
**cloudformationStackArn**
主 CloudFormation 堆栈的亚马逊资源名称 (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`
**ec2 AmiInfo**
**ami\$1id**
亚马逊 EC2 AMI ID。
类型：字符串
**imageBuildStatus**
映像构建状态。
类型：字符串
有效值：`BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE`
**区域**
AWS 区域 在其中构建镜像。
类型：字符串
**version**
用于构建镜像的 AWS ParallelCluster 版本。
类型：字符串
**validationMessages**
验证级别低于 `validationFailureLevel` 的消息的列表。消息列表是在配置验证期间收集的。
**id**
验证器 ID。
类型：字符串
**level**
验证级别。
类型：字符串
有效值：`INFO | WARNING | ERROR`
**message**
验证消息。
类型：字符串
**type**
验证器的类型。
类型：字符串
## 示例
------
#### [ Python ]
**请求**
```
$ build_image(custom-image-id, custom-image-config.yaml)
```
**200 响应**
```
{
"image": {
"cloudformation_stack_arn": "arn:aws:cloudformation:us-east-1:123456789012:stack/custom-image-id/711b76b0-af81-11ec-a29f-0ee549109f1f",
"cloudformation_stack_status": "CREATE_IN_PROGRESS",
"image_build_status": "BUILD_IN_PROGRESS",
"image_id": "custom-image-id",
"region": "us-east-1",
"version": "3.2.1"
}
}
```
------
# createCluster
在 AWS 区域中创建托管集群。
**Topics**
+ [请求语法](#create-cluster-request)
+ [请求正文](#create-cluster-request-body)
+ [响应语法](#create-cluster-response)
+ [响应正文](#create-cluster-response-body)
+ [示例](#create-cluster-example)
## 请求语法
```
POST /v3/clusters
{
"clusterName": "string",
"clusterConfiguration": "string",
"dryrun": boolean,
"region": "string",
"rollbackOnFailure", boolean,
"suppressValidators": [ "string" ],
"validationFailureLevel": "string"
}
```
## 请求正文
**clusterConfiguration**
集群配置作为 YAML 文档。
类型：字符串。
必需：是
**clusterName**
要创建的集群的名称。
名称必须以字母字符开头。名称最多可以包含 60 个字符。如果启用 Slurm 会计，则名称最多可包含 40 个字符。
类型：字符串。
必需：是
**dryrun**
如果设置为`true`，则仅执行请求验证，但不创建任何资源。使用此参数可验证集群配置。默认值为 `false`。
类型：布尔值
必需：否
**region**
AWS 区域 集群所在的。
类型：字符串
必需：否
**rollbackOnFailure**
如果设置为`true`，则在集群创建失败时会进行集群堆栈回滚。默认值为 `true`。
类型：布尔值
必需：否
**suppressValidators**
标识一个或多个要禁止的配置验证器。
类型：字符串列表
格式：`(ALL|type:[A-Za-z0-9]+)`
必需：否
**validationFailureLevel**
导致集群创建失败的最低验证级别。默认值为 `ERROR`。
类型：字符串
有效值：`INFO | WARNING | ERROR`
必需：否
## 响应语法
```
{
"cluster": {
"clusterName": "string",
"region": "string",
"version": "string",
"cloudformationStackArn": "string",
"cloudformationStackStatus": "CREATE_IN_PROGRESS",
"clusterStatus": "CREATE_IN_PROGRESS",
"scheduler": {
"type": "string",
"metadata": {
"name": "string",
"version": "string"
}
}
},
"validationMessages": [
{
"id": "string",
"type": "string",
"level": "INFO",
"message": "string"
}
]
}
```
## 响应正文
**clusterName**
集群的名称。
类型：字符串
**cloudformationStackArn**
主 CloudFormation 堆栈的亚马逊资源名称 (ARN)。
类型：字符串
**cloudformationStackStatus**
类型：字符串
有效值：`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`
**clusterStatus**
类型：字符串
有效值：`CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_FAILED`
**区域**
创建 AWS 区域 集群时使用的。
类型：字符串
**scheduler**
**metadata**
调度器元数据
**名称**
调度器的名称。
类型：字符串
**version**
调度器版本。
类型：字符串
**type**
调度器类型。
类型：字符串
**version**
用于创建集群的 AWS ParallelCluster 版本。
类型：字符串
**validation\$1messages**
验证级别低于 `validationFailureLevel` 的消息的列表。消息列表是在配置验证期间收集的。
**id**
验证器的 ID。
类型：字符串
**level**
类型：字符串
有效值：`INFO | WARNING | ERROR`
**message**
验证消息。
类型：字符串
**type**
验证器的类型。
类型：字符串
## 示例
------
#### [ Python ]
**请求**
```
$ create_cluster(cluster_name_3x, cluster-config.yaml)
```
**200 响应**
```
{
"cluster": {
"cloudformation_stack_arn": "arn:aws:cloudformation:us-east-1:123456789012:stack/cluster-3x/e0462730-50b5-11ed-99a3-0a5ddc4a34c7",
"cloudformation_stack_status": "CREATE_IN_PROGRESS",
"cluster_name": "cluster-3x",
"cluster_status": "CREATE_IN_PROGRESS",
"region": "us-east-1",
"scheduler": {
"type": "slurm"
},
"version": "3.2.1"
}
}
```
------
# deleteCluster
开始删除集群。
**Topics**
+ [请求语法](#delete-cluster-request)
+ [请求正文](#delete-cluster-request-body)
+ [响应语法](#delete-cluster-response)
+ [响应正文](#delete-cluster-response-body)
+ [示例](#delete-cluster-example)
## 请求语法
```
DELETE /v3/clusters/{clusterName}
{
"region": "string"
}
```
## 请求正文
**clusterName**
集群的名称。
类型：字符串。
必需：是
**区域**
AWS 区域 在其中删除集群。
类型：字符串
必需：否
## 响应语法
```
{
"cluster": {
"clusterName": "string",
"region": "string",
"version": "string",
"cloudformationStackArn": "string",
"cloudformationStackStatus": "DELETE_IN_PROGRESS",
"clusterStatus": "DELETE_IN_PROGRESS",
"scheduler": {
"type": "string",
"metadata": {
"name": "string",
"version": "string"
}
}
}
}
```
## 响应正文
**cluster**
集群实例列表。
**clusterName**
集群的名称。
类型：字符串
**cloudformationStackArn**
主 CloudFormation 堆栈的亚马逊资源名称 (ARN)。
类型：字符串
**cloudformationStackStatus**
类型：字符串
有效值：`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`
**clusterStatus**
类型：字符串
有效值：`CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_FAILED`
**区域**
AWS 区域 在其中创建集群。
类型：字符串
**scheduler**
**metadata**
调度器元数据。
**名称**
调度器的名称。
类型：字符串
**version**
调度器版本。
类型：字符串
**type**
调度器类型。
类型：字符串
**version**
用于创建集群的 AWS ParallelCluster 版本。
类型：字符串
## 示例
------
#### [ Python ]
**请求**
```
$ delete_cluster(cluster_name_3x)
```
**200 响应**
```
{
"cluster": {
"cloudformation_stack_arn": "arn:aws:cloudformation:us-east-1:123456789012:stack/cluster_name_3x/16b49540-aee5-11ec-8e18-0ac1d712b241",
"cloudformation_stack_status": "DELETE_IN_PROGRESS",
"cluster_name": "cluster_name_3x",
"cluster_status": "DELETE_IN_PROGRESS",
"region": "us-east-1",
"version": "3.2.1"
}
}
```
------
# deleteClusterInstances
开始强制终止所有集群计算节点。此操作不支持 AWS Batch 集群。
**Topics**
+ [请求语法](#delete-cluster-instances-request)
+ [请求正文](#delete-cluster-instances-request-body)
+ [响应正文](#delete-cluster-instances-response-body)
+ [示例](#delete-cluster-instances-example)
## 请求语法
```
DELETE /v3/clusters/{clusterName}/instances
{
"force": boolean,
"region": "string"
}
```
## 请求正文
**clusterName**
集群的名称。
类型：字符串。
必需：是
**force**
如果设置为 `true`，则在找不到具有给定名称的集群时强制删除。默认值为 `false`。
类型：布尔值
必需：否
**region**
AWS 区域 集群所在的。
类型：字符串
必需：否
## 响应正文
无
## 示例
------
#### [ Python ]
**请求**
```
$ delete_cluster_instances(cluster_name_3x)
```
**200 响应**
无
------
# deleteImage
开始删除自定义 AWS ParallelCluster 镜像。
**Topics**
+ [请求语法](#delete-image-request)
+ [请求正文](#delete-image-request-body)
+ [响应语法](#delete-image-response)
+ [响应正文](#delete-image-response-body)
+ [示例](#delete-image-example)
## 请求语法
```
DELETE /v3/images/custom/{imageId}
{
"force": boolean,
"region": "string"
}
```
## 请求正文
**imageId**
映像的 ID。
类型：字符串。
必需：是
**force**
如果设置为 `true`，则强制删除 AMI。如果有使用 AMI 的实例或者共享了 AMI，则使用此参数。默认值为 `false`。
类型：布尔值
必需：否
**region**
图像 AWS 区域 是在其中创建的。
类型：字符串
必需：否
## 响应语法
```
{
"image": {
"imageId": "string",
"ec2AmiInfo": {
"amiId": "string"
},
"region": "string",
"version": "string",
"cloudformationStackArn": "string",
"imageBuildStatus": "DELETE_IN_PROGRESS",
"cloudformationStackStatus": "DELETE_IN_PROGRESS"
}
}
```
## 响应正文
**image**
**cloudformationStackArn**
主 CloudFormation 堆栈的亚马逊资源名称 (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`
**ec2 AmiInfo**
**amiId**
亚马逊 EC2 AMI ID。
类型：字符串
**imageBuildStatus**
映像构建状态。
类型：字符串
有效值：`BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE`
**imageId**
映像的 ID。
类型：字符串
**区域**
AWS 区域 在其中创建镜像。
类型：字符串
**version**
用于构建镜像的 AWS ParallelCluster 版本。
类型：字符串
## 示例
------
#### [ Python ]
**请求**
```
$ delete_image(custom-image-id)
```
**200 响应**
```
{
"image": {
"image_build_status": "DELETE_IN_PROGRESS",
"image_id": "custom-image-id",
"region": "us-east-1",
"version": "3.2.1"
}
}
```
------
# describeCluster
获取有关现有集群的详细信息。
**Topics**
+ [请求语法](#describe-cluster-request)
+ [请求正文](#describe-cluster-request-body)
+ [响应语法](#describe-cluster-response)
+ [响应正文](#describe-cluster-response-body)
+ [示例](#describe-cluster-example)
## 请求语法
```
GET /v3/clusters/{clusterName}
{
"region": "string"
}
```
## 请求正文
**clusterName**
集群的名称。
类型：字符串。
必需：是
**区域**
AWS 区域 集群所在的。
类型：字符串
必需：否
## 响应语法
**注意**
`failureReason`已更改为`failures`从 3.5.0 AWS ParallelCluster 版本开始。
```
{
"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 堆栈的亚马逊资源名称 (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**
上次更新集群时的时间戳。
类型：日期时间
**区域**
AWS 区域 在其中创建集群。
类型：字符串
**tags**
与集群关联的标签的列表。
**key**
标签名称。
类型：字符串
**tag**
标签值。
类型：字符串
**version**
用于创建集群的 AWS ParallelCluster 版本。
类型：字符串
**failures**
集群堆栈处于 `CREATE_FAILED` 状态时的故障列表。
**failureCode**
集群堆栈处于 `CREATE_FAILED` 状态时的故障代码。
类型：字符串
**failureReason**
集群堆栈处于 `CREATE_FAILED` 状态时的故障原因。
类型：字符串
**head\$1node**
集群头节点。
**instanceId**
亚马逊 EC2 实例 ID。
类型：字符串
**instanceType**
Amazon EC2 实例类型。
类型：字符串
**launchTime**
Amazon EC2 实例的启动时间。
类型：日期时间
**privateIpAddress**
集群私有 IP 地址。
类型：字符串
**publicIpAddress**
集群公共 IP 地址。
类型：字符串
**状态**
头节点实例状态。
类型：字符串
有效值：`pending | running | shutting-down | terminated | stopping | stopped`
**scheduler**
**metadata**
调度器元数据。
**名称**
调度器的名称。
类型：字符串
**version**
调度器版本。
类型：字符串
**loginNodes**
status
登录节点状态。
类型：字符串
有效值：`PENDING | FAILED | ACTIVE`
address
登录节点地址。
类型：字符串
poolName
登录节点池名称。
类型：字符串
scheme
登录节点方案。
类型：字符串
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"
}
```
------
# describeClusterInstances
描述属于集群的实例。
**Topics**
+ [请求语法](#describe-cluster-instances-request)
+ [请求正文](#describe-cluster-instances-request-body)
+ [响应语法](#describe-cluster-instances-response)
+ [响应正文](#describe-cluster-instances-response-body)
+ [示例](#describe-cluster-instances-example)
## 请求语法
```
GET /v3/clusters/{clusterName}/instances
{
"nextToken": "string",
"nodeType": "string",
"queueName": "string",
"region": "string"
}
```
## 请求正文
**clusterName**
集群的名称。
类型：字符串。
必需：是
**nextToken**
用于获取下一组结果的令牌。
类型：字符串
必需：否
**nodeType**
按节点类型筛选实例。
类型：字符串
有效值：`HeadNode`、`ComputeNode`、`LoginNode`
必需：否
**queueName**
按队列名称筛选实例。
类型：字符串
必需：否
**region**
AWS 区域 集群所在的。
类型：字符串
必需：否
## 响应语法
```
{
"nextToken": "string",
"instances": [
{
"instanceId": "string",
"instanceType": "string",
"launchTime": "2019-08-24T14:15:22Z",
"privateIpAddress": "string",
"publicIpAddress": "string",
"state": "pending",
"nodeType": "HeadNode",
"queueName": "string",
"poolName": "string"
}
]
}
```
## 响应正文
**instances**
集群实例列表。
**instanceId**
亚马逊 EC2 实例 ID。
类型：字符串
**instanceType**
Amazon EC2 实例类型。
类型：字符串
**launchTime**
Amazon EC2 实例的启动时间。
类型：日期时间
**nodeType**
节点类型。
类型：字符串
有效值：`HeadNode`、`ComputeNode`、`LoginNode`
**publicIpAddress**
集群公共 IP 地址。
类型：字符串
**queueName**
Amazon EC2 实例支持节点的队列名称。
类型：字符串
**状态**
节点 Amazon EC2 实例状态。
类型：字符串
有效值：`pending | running | shutting-down | terminated | stopping | stopped`
**nextToken**
用于检索下一组结果的令牌，没有更多结果时为 `null`。
类型：字符串
## 示例
------
#### [ Python ]
**请求**
```
$ describe_cluster_instances(cluster_name_3x)
```
**200 响应**
```
{
"instances": [
{
"instance_id": "i-abcdef01234567890",
"instance_type": "t2.micro",
"launch_time": datetime.datetime(2022, 3, 30, 14, 2, 7, tzinfo=tzlocal()),
"node_type": "HeadNode",
"private_ip_address": "192.0.2.5",
"public_ip_address": "198.51.100.180",
"state": "running"
}
]
}
```
------
# describeComputeFleet
描述计算实例集的状态。
**Topics**
+ [请求语法](#describe-compute-fleet-request)
+ [请求正文](#describe-compute-fleet-request-body)
+ [响应语法](#describe-compute-fleet-response)
+ [响应正文](#describe-compute-fleet-response-body)
+ [示例](#describe-compute-fleet-example)
## 请求语法
```
GET /v3/clusters/{clusterName}/computefleet
{
"region": "string"
}
```
## 请求正文
**clusterName**
集群的名称。
类型：字符串。
必需：是
**区域**
AWS 区域 集群所在的。
类型：字符串
必需：否
## 响应语法
```
{
"status": "START_REQUESTED",
"lastStatusUpdatedTime": "2019-08-24T14:15:22Z"
}
```
## 响应正文
**状态**
类型：字符串
有效值：`START_REQUESTED | STARTING | RUNNING | PROTECTED | STOP_REQUESTED | STOPPING | STOPPED | UNKNOWN | ENABLED | DISABLED`
**lastStatusUpdated时间**
代表上次状态更新时间的时间戳。
类型：日期时间
## 示例
------
#### [ Python ]
**请求**
```
$ describe_compute_fleet(cluster_name_3x)
```
**200 响应**
```
{
"last_status_updated_time": datetime.datetime(2022, 3, 28, 22, 27, 14, tzinfo=tzlocal()),
"status": "RUNNING"
}
```
------
# describeImage
获取有关现有映像的详细信息。
**Topics**
+ [请求语法](#describe-image-request)
+ [请求正文](#describe-image-request-body)
+ [响应语法](#describe-image-response)
+ [响应正文](#describe-image-response-body)
+ [示例](#describe-image-example)
## 请求语法
```
GET /v3/images/custom/{imageId}
{
"region": "string"
}
```
## 请求正文
**imageId**
映像的 ID。
类型：字符串。
必需：是
**区域**
图像 AWS 区域 是在其中创建的。
类型：字符串
必需：否
## 响应语法
```
{
"imageId": "string",
"region": "string",
"version": "string",
"imageBuildStatus": "BUILD_IN_PROGRESS",
"imageBuildLogsArn": "string",
"cloudformationStackStatus": "CREATE_IN_PROGRESS",
"cloudformationStackStatusReason": "string",
"cloudformationStackArn": "string",
"creationTime": "2019-08-24T14:15:22Z",
"cloudformationStackCreationTime": "2019-08-24T14:15:22Z",
"cloudformationStackTags": [
{
"key": "string",
"value": "string"
}
],
"imageConfiguration": {
"url": "string"
},
"imagebuilderImageStatus": "PENDING",
"imagebuilderImageStatusReason": "string",
"ec2AmiInfo": {
"amiId": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"amiName": "string",
"architecture": "string",
"state": "PENDING",
"description": "string"
}
}
```
## 响应正文
**imageId**
要检索其详细信息的映像的 ID。
类型：字符串
**imageBuildStatus**
映像构建状态。
类型：字符串
有效值：`BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE`
**imageConfiguration**
**url**
映像配置文件的 URL。
类型：字符串
**区域**
AWS 区域 在其中创建镜像。
类型：字符串
**version**
用于构建镜像的 AWS ParallelCluster 版本。
类型：字符串
**cloudformationStackArn**
主 CloudFormation 堆栈的亚马逊资源名称 (ARN)。
类型：字符串
**cloudformationStackCreation时间**
CloudFormation 堆栈的创建时间。
类型：日期时间
**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`
**cloudformationStackStatus原因**
CloudFormation 堆栈状态的原因。
类型：字符串
**cloudformationStackTags**
CloudFormation 堆栈的标签列表。
**键**
标签名称。
类型：字符串
**value**
标签值。
类型：字符串
**creationTime**
图像的创建时间。
类型：日期时间
**ec2 AmiInfo**
**amiId**
亚马逊 EC2 AMI ID。
类型：字符串
**amiName**
亚马逊 EC2 AMI 的名称。
类型：字符串
**架构**
亚马逊 EC2 AMI 架构。
类型：字符串
**状态**
亚马逊 EC2 AMI 的状态。
类型：字符串
有效值：`PENDING | AVAILABLE | INVALID | DEREGISTERED | TRANSIENT | FAILED | ERROR`
**tags**
亚马逊 EC2 AMI 标签列表。
**key**
标签名称。
类型：字符串
**值**
标签值。
类型：字符串
**imagebuilderImageStatus**
ImageBuilder 图像状态。
类型：字符串
有效值：`PENDING | CREATING | BUILDING | TESTING | DISTRIBUTING | INTEGRATING | AVAILABLE | CANCELLED | FAILED | DEPRECATED | DELETED`
**imagebuilderImageStatus原因**
ImageBuilder 图片处于该状态的原因。
类型：字符串
**imageBuildLogsArn**
映像构建过程日志的 Amazon 资源名称 (ARN)。
类型：字符串
## 示例
------
#### [ Python ]
**请求**
```
$ describe_image(custom-image-id)
```
**200 响应**
```
{
"cloudformation_stack_arn": "arn:aws:cloudformation:us-east-1:123456789012:stack/custom-image-id/6accc570-b080-11ec-845e-0e2dc6386985",
"cloudformation_stack_creation_time": datetime.datetime(2022, 3, 30, 23, 23, 33, 731000, tzinfo=tzlocal()),
"cloudformation_stack_status": "CREATE_IN_PROGRESS",
"cloudformation_stack_tags": [
{
"key": "parallelcluster:version", "value": "3.2.1"
},
{
"key": "parallelcluster:image_name",
"value": 'custom-image-id"
},
{
"key": "parallelcluster:custom-image-id",
"value": "custom-image-id"
},
{
"key": 'parallelcluster:amzn-s3-demo-bucket",
"value": 'amzn-s3-demo-bucket"
},
{
"key": "parallelcluster:s3_image_dir",
"value": "parallelcluster/3.2.1/images/custom-image-id-1234567890abcdef0"
},
{
"key": "parallelcluster:build_log",
"value": "arn:aws:logs:us-east-1:123456789012:log-group:/aws/imagebuilder/ParallelClusterImage-custom-image-id"
},
{
"key": "parallelcluster:build_config",
"value": "s3://amzn-s3-demo-bucket/parallelcluster/3.2.1/images/custom-image-id-1234567890abcdef0/configs/image-config.yaml"
}
],
"image_build_logs_arn": "arn:aws:logs:us-east-1:123456789012:log-group:/aws/imagebuilder/ParallelClusterImage-alinux2-image",
"image_build_status": "BUILD_IN_PROGRESS",
"image_configuration": {
"url": "https://amzn-s3-demo-bucket.s3.amazonaws.com/parallelcluster/3.2.1/images/custom-image-id-1234567890abcdef0/configs/image-config.yaml?..."
},
"image_id": 'custom-image-id',
"imagebuilder_image_status": "PENDING",
"region": "us-east-1",
"version": "3.2.1"
}
```
------
# getClusterLog活动
检索与日志流关联的事件。
**Topics**
+ [请求语法](#get-cluster-log-events-request)
+ [请求正文](#get-cluster-log-events-request-body)
+ [响应语法](#get-cluster-log-events-response)
+ [响应正文](#get-cluster-log-events-response-body)
+ [示例](#get-cluster-log-events-example)
## 请求语法
```
GET /v3/clusters/{clusterName}/logstreams/{logStreamName}
{
"endTime": datetime,
"limit": float,
"nextToken": "string",
"region": "string",
"startFromHead": boolean,
"startTime": datetime
}
```
## 请求正文
**clusterName**
集群的名称。
类型：字符串。
必需：是
**logStreamName**
日志流的名称。
类型：字符串。
必需：是
**endTime**
时间范围的结束，以 ISO 8601 格式表示。不包括时间戳等于或晚于该时间的事件。
类型：日期时间
格式：`2021-01-01T20:00:00Z`
必需：否
**limit**
返回的日志事件的最大数目。如果您不指定值，则最大值是响应大小为 1 MB 或最多 10,000 个日志事件中可以容纳的日志事件数。
类型：浮点数
必需：否
**nextToken**
用于获取下一组结果的令牌。
类型：字符串
必需：否
**region**
AWS 区域 集群所在的。
类型：字符串
必需：否
**startFromHead**
如果设置为 `true`，则最先返回最早的日志事件。如果值为 `false`，则最先返回最新的日志事件。默认值为 `false`。
类型：布尔值
必需：否
**startTime**
时间范围的开始，以 ISO 8601 格式表示。包括时间戳等于或晚于该时间的事件。
类型：日期时间
格式：`2021-01-01T20:00:00Z`
必需：否
## 响应语法
```
{
"nextToken": "string",
"prevToken": "string",
"events": [
{
"timestamp": "2019-08-24T14:15:22Z",
"message": "string"
}
]
}
```
## 响应正文
**events**
筛选的事件的列表。
**message**
事件消息。
类型：字符串
**timestamp**
事件时间戳。
类型：日期时间
**nextToken**
用于检索下一组结果的令牌，没有更多结果时为 `null`。
类型：字符串
**prevToken**
一种标记，可用于检索前一组结果，`null`或者在没有其他结果时使用。
类型：字符串
## 示例
------
#### [ Python ]
**请求**
```
$ get_cluster_log_events(cluster_name_3x, log_stream_name=ip-192-0-2-26.i-abcdef01234567890.cfn-init)
```
**200 响应**
```
"events": [
{
"message": "2022-09-22 16:40:15,127 [DEBUG] CloudFormation client initialized with endpoint https://cloudformation.us-east-1.amazonaws.com",
"timestamp": "2022-09-22T16:40:15.127Z"
},
{
"message": "2022-09-22 16:40:15,127 [DEBUG] Describing resource HeadNodeLaunchTemplate in stack cluster_name_3x",
"timestamp": "2022-09-22T16:40:15.127Z"
},
...
]
```
------
# getClusterStack活动
检索与集群的堆栈关联的事件。
**注意**
从 3.6.0 版开始， AWS ParallelCluster 使用嵌套堆栈来创建与队列和计算资源关联的资源。`GetClusterStackEvents` API 和 `pcluster get-cluster-stack-events` 命令仅返回集群主堆栈事件。您可以在 CloudFormation 控制台中查看集群堆栈事件，包括与队列和计算资源相关的事件。
**Topics**
+ [请求语法](#get-cluster-stack-events-request)
+ [请求正文](#get-cluster-stack-events-request-body)
+ [响应语法](#get-cluster-stack-events-response)
+ [响应正文](#get-cluster-stack-events-response-body)
+ [示例](#get-cluster-stack-events-example)
## 请求语法
```
GET /v3/clusters/{clusterName}/stackevents
{
"nextToken": "string",
"region": "string"
}
```
## 请求正文
**clusterName**
集群的名称。
类型：字符串。
必需：是
**nextToken**
用于获取下一组结果的令牌。
类型：字符串
必需：否
**region**
AWS 区域 集群所在的。
类型：字符串
必需：否
## 响应语法
```
{
"nextToken": "string",
"events": [
{
"stackId": "string",
"eventId": "string",
"stackName": "string",
"logicalResourceId": "string",
"physicalResourceId": "string",
"resourceType": "string",
"timestamp": "2019-08-24T14:15:22Z",
"resourceStatus": "CREATE_IN_PROGRESS",
"resourceStatusReason": "string",
"resourceProperties": "string",
"clientRequestToken": "string"
}
]
}
```
## 响应正文
**events**
筛选的事件的列表。
**clientRequestToken**
传递给生成此事件的操作的令牌。
类型：字符串
**eventId**
此事件的唯一 ID。
类型：字符串
**logicalResourceId**
模板中指定资源的逻辑名称。
类型：字符串
**physicalResourceId**
与资源的物理实例关联的名称或唯一标识符。
类型：字符串
**resourceProperties**
用于创建资源的属性的 BLOB。
类型：字符串
**resourceStatus**
资源状态。
类型：字符串
有效值：`CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | DELETE_SKIPPED | UPDATE_IN_PROGRESS | UPDATE_FAILED | UPDATE_COMPLETE | IMPORT_FAILED | IMPORT_COMPLETE | IMPORT_IN_PROGRESS | IMPORT_ROLLBACK_IN_PROGRESS | IMPORT_ROLLBACK_FAILED | IMPORT_ROLLBACK_COMPLETE`
**resourceStatusReason**
与资源关联的成功或失败消息。
类型：字符串
**resourceType**
资源的类型。
类型：字符串
**stackId**
堆栈实例的唯一 ID 名称。
类型：字符串
**stackName**
与堆栈关联的名称。
类型：字符串
**timestamp**
上次更新状态的时间。
类型：日期时间
**nextToken**
用于检索下一组结果的令牌，没有更多结果时为 `null`。
类型：字符串
## 示例
------
#### [ Python ]
**请求**
```
$ get_cluster_stack_events(cluster_name_3x)
```
**200 响应**
```
{
"events": [
{
"event_id": "590b3820-b081-11ec-985e-0a7af5751497",
"logical_resource_id": "cluster_name_3x",
"physical_resource_id": "arn:aws:cloudformation:us-east-1:123456789012:stack/cluster_name_3x/11a59710-b080-11ec-b8bd-129def1380e9",
"resource_status": "CREATE_COMPLETE",
"resource_type": "AWS::CloudFormation::Stack",
"stack_id": "arn:aws:cloudformation:us-east-1:123456789012:stack/cluster_name_3x/11a59710-b080-11ec-b8bd-129def1380e9",
"stack_name": "cluster_name_3x",
"timestamp": datetime.datetime(2022, 3, 30, 23, 30, 13, 268000, tzinfo=tzlocal())
},
...
]
}
```
------
# getImageLog活动
检索与映像构建关联的事件。
**Topics**
+ [请求语法](#get-image-log-events-request)
+ [请求正文](#get-image-log-events-request-body)
+ [响应语法](#get-image-log-events-response)
+ [响应正文](#get-image-log-events-response-body)
+ [示例](#get-image-log-events-example)
## 请求语法
```
GET /v3/images/custom/{imageId}/logstreams/{logStreamName}
{
"endTime": datetime,
"limit": float,
"nextToken": "string",
"region": "string",
"startFromHead": boolean,
"startTime": datetime
}
```
## 请求正文
**imageId**
映像的 ID。
类型：字符串。
必需：是
**logStreamName**
日志流的名称。
类型：字符串。
必需：是
**endTime**
时间范围的结束，以 ISO 8601 格式表示。不包括时间戳等于或晚于该时间的事件。
类型：日期时间
格式：`2021-01-01T20:00:00Z`
必需：否
**limit**
返回的日志事件的最大数目。如果不指定值，则最大值为 1 MB 的响应大小所能容纳的日志事件数量，最多可达 10000 个日志事件。
类型：浮点数
必需：否
**nextToken**
用于获取下一组结果的令牌。
类型：字符串
必需：否
**region**
AWS 区域 那张图片在里面。
类型：字符串
必需：否
**startFromHead**
如果设置为 `true`，则最先返回最早的日志事件。如果设置为 false，则最先返回最新的日志事件。默认值为 `false`。
类型：布尔值
必需：否
**startTime**
时间范围的开始，以 ISO 8601 格式表示。包括时间戳等于或晚于该时间的事件。
类型：日期时间
格式：`2021-01-01T20:00:00Z`
必需：否
## 响应语法
```
{
"nextToken": "string",
"prevToken": "string",
"events": [
{
"timestamp": "2019-08-24T14:15:22Z",
"message": "string"
}
]
}
```
## 响应正文
**events**
筛选的事件的列表。
**message**
事件消息。
类型：字符串
**timestamp**
事件时间戳。
类型：日期时间
**nextToken**
用于检索下一组结果的令牌，没有更多结果时为 `null`。
类型：字符串
**prevToken**
一种标记，可用于检索前一组结果，`null`或者在没有其他结果时使用。
类型：字符串
## 示例
------
#### [ Python ]
**请求**
```
$ get_image_log_events(image_id, log_stream_name=3.2.1/1)
```
**200 响应**
```
"events": [
{
"message": "ExecuteBash: STARTED EXECUTION",
"timestamp": 2022-04-05T15:51:20.228Z"
},
{
"message": "ExecuteBash: Created temporary directory: /tmp/1234567890abcdef0",
"timestamp": "2022-04-05T15:51:20.228Z"
},
...
]
```
------
# getImageStack活动
检索与映像构建的堆栈关联的事件。
**Topics**
+ [请求语法](#get-image-stack-events-request)
+ [请求正文](#get-image-stack-events-request-body)
+ [响应语法](#get-image-stack-events-response)
+ [响应正文](#get-image-stack-events-response-body)
+ [示例](#get-image-stack-events-example)
## 请求语法
```
GET /v3/images/custom/{imageId}/stackevents
{
"nextToken": "string",
"region": "string"
}
```
## 请求正文
**imageId**
映像的 ID。
类型：字符串。
必需：是
**nextToken**
用于获取下一组结果的令牌。
类型：字符串
必需：否
**region**
图像所在 AWS 区域 的那个。
类型：字符串
必需：否
## 响应语法
```
{
"nextToken": "string",
"events": [
{
"stackId": "string",
"eventId": "string",
"stackName": "string",
"logicalResourceId": "string",
"physicalResourceId": "string",
"resourceType": "string",
"timestamp": "2019-08-24T14:15:22Z",
"resourceStatus": "CREATE_IN_PROGRESS",
"resourceStatusReason": "string",
"resourceProperties": "string",
"clientRequestToken": "string"
}
]
}
```
## 响应正文
**events**
筛选的事件的列表。
**clientRequestToken**
传递给生成此事件的操作的令牌。
类型：字符串
**eventId**
此事件的唯一 ID。
类型：字符串
**logicalResourceId**
模板中指定资源的逻辑名称。
类型：字符串
**physicalResourceId**
与资源的物理实例关联的名称或唯一标识符。
类型：字符串
**resourceProperties**
用于创建资源的属性的 BLOB。
类型：字符串
**resourceStatus**
资源状态。
类型：字符串
有效值：`CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | DELETE_SKIPPED | UPDATE_IN_PROGRESS | UPDATE_FAILED | UPDATE_COMPLETE | IMPORT_FAILED | IMPORT_COMPLETE | IMPORT_IN_PROGRESS | IMPORT_ROLLBACK_IN_PROGRESS | IMPORT_ROLLBACK_FAILED | IMPORT_ROLLBACK_COMPLETE`
**resourceStatusReason**
与资源关联的成功或失败消息。
类型：字符串
**resourceType**
资源的类型。
类型：字符串
**stackId**
堆栈实例的唯一 ID 名称。
类型：字符串
**stackName**
与堆栈关联的名称。
类型：字符串
**timestamp**
上次更新状态的时间。
类型：日期时间
**nextToken**
用于检索下一组结果的令牌，没有更多结果时为 `null`。
类型：字符串
## 示例
------
#### [ Python ]
**请求**
```
$ get_image_stack_events(image_id)
```
**200 响应**
```
{
'events': [
{
'event_id': 'ParallelClusterImage-CREATE_IN_PROGRESS-2022-03-30T23:26:33.499Z',
'logical_resource_id': 'ParallelClusterImage',
'physical_resource_id': 'arn:aws:imagebuilder:us-east-1:123456789012:image/parallelclusterimage-alinux2-image/3.2.1/1',
'resource_properties': {
"InfrastructureConfigurationArn":"arn:aws:imagebuilder:us-east-1:123456789012:infrastructure-configuration/parallelclusterimage-6accc570-b080-11ec-845e-0e2dc6386985",
"ImageRecipeArn":"arn:aws:imagebuilder:us-east-1:123456789012:image-recipe/parallelclusterimage-alinux2-image/3.2.1",
"DistributionConfigurationArn":"arn:aws:imagebuilder:us-east-1:123456789012:distribution-configuration/parallelclusterimage-6accc570-b080-11ec-845e-0e2dc6386985",
"EnhancedImageMetadataEnabled":"false",
"Tags": {
"parallelcluster:image_name":"alinux2-image","parallelcluster:image_id":"alinux2-image"
}
},
'resource_status': 'CREATE_IN_PROGRESS',
'resource_status_reason': 'Resource creation Initiated',
'resource_type': 'AWS::ImageBuilder::Image',
'stack_id': 'arn:aws:cloudformation:us-east-1:123456789012:stack/alinux2-image/6accc570-b080-11ec-845e-0e2dc6386985',
'stack_name': 'alinux2-image',
'timestamp': datetime.datetime(2022, 3, 30, 23, 26, 33, 499000, tzinfo=tzlocal())
},
...
]
}
```
------
# listClusters
检索现有集群的列表。
**Topics**
+ [请求语法](#list-clusters-request)
+ [请求正文](#list-clusters-request-body)
+ [响应语法](#list-clusters-response)
+ [响应正文](#list-clusters-response-body)
+ [示例](#list-clusters-example)
## 请求语法
```
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 堆栈的亚马逊资源名称 (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**
调度器元数据。
**名称**
调度器的名称。
类型：字符串
**version**
调度器版本。
类型：字符串
**type**
调度器的类型。
类型：字符串
**区域**
AWS 区域 在其中创建集群。
类型：字符串
**version**
用于创建集群的 AWS ParallelCluster 版本。
类型：字符串
**nextToken**
用于检索下一组结果的令牌，没有更多结果时为 `null`。
类型：字符串
## 示例
------
#### [ 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'
},
...
]
}
```
------
# listClusterLog直播
检索与集群关联的日志流的列表。
**Topics**
+ [请求语法](#list-cluster-log-streams-request)
+ [请求正文](#list-cluster-log-streams-request-body)
+ [响应语法](#list-cluster-log-streams-response)
+ [响应正文](#list-cluster-log-streams-response-body)
+ [示例](#list-cluster-log-streams-example)
## 请求语法
```
GET /v3/clusters/{clusterName}/logstreams
{
"filters": [ "string" ],
"nextToken": "string",
"region": "string"
}
```
## 请求正文
**clusterName**
集群的名称。
类型：字符串。
必需：是
**filters**
筛选日志流。
可接受的筛选器包括：
+ private-dns-name：实例私有 DNS 名称的缩写形式（例如 ip-10-0-0-0-101）。
+ node-type：有效值：`HeadNode`。
类型：字符串数组，唯一
格式：`Name=a,Values=1 Name=b,Values=2,3`
必需：否
**nextToken**
用于获取下一组结果的令牌。
类型：字符串
必需：否
**region**
AWS 区域 集群所在的。
类型：字符串
必需：否
## 响应语法
```
{
"nextToken": "string",
"logStreams": [
{
"logStreamName": "string",
"creationTime": "2019-08-24T14:15:22Z",
"firstEventTimestamp": "2019-08-24T14:15:22Z",
"lastEventTimestamp": "2019-08-24T14:15:22Z",
"lastIngestionTime": "2019-08-24T14:15:22Z",
"uploadSequenceToken": "string",
"logStreamArn": "string"
}
]
}
```
## 响应正文
**logStreams**
日志流的列表。
**creationTime**
创建流的时间。
类型：日期时间
**firstEventTimestamp**
流中第一个事件的时间。
类型：日期时间
**lastEventTimestamp**
流中最后一个事件的时间。该 lastEventTime 值以最终一致性为基础进行更新。它通常会在摄取后不到一小时内更新，但在极少数情况下可能需要更长时间。
类型：日期时间
**lastIngestionTime**
上次摄取时间。
类型：日期时间
**logStreamArn**
日志流的 Amazon 资源名称 (ARN)。
类型：字符串
**logStreamName**
日志流的名称。
类型：字符串
**uploadSequenceToken**
序列令牌。
类型：字符串
**nextToken**
用于检索下一组结果的令牌，没有更多结果时为 `null`。
类型：字符串
## 示例
------
#### [ Python ]
**请求**
```
$ list_cluster_log_streams(cluster_name_3x)
```
**200 响应**
```
{
'log_streams': [
{
'creation_time': datetime.datetime(2022, 3, 30, 14, 7, 34, 354000, tzinfo=tzlocal()),
'first_event_timestamp': datetime.datetime(2022, 3, 30, 14, 6, 41, 444000, tzinfo=tzlocal()),
'last_event_timestamp': datetime.datetime(2022, 3, 30, 14, 25, 55, 462000, tzinfo=tzlocal()),
'last_ingestion_time': datetime.datetime(2022, 3, 30, 14, 49, 50, 62000, tzinfo=tzlocal()),
'log_stream_arn': 'arn:aws:logs:us-east-1:123456789012:log-group:/aws/parallelcluster/cluster_name_3x:log-stream:ip-192-0-2-26.i-abcdef01234567890.cfn-init',
'log_stream_name': 'ip-192-0-2-26.i-abcdef01234567890.cfn-init',
...
'upload_sequence_token': '####'
},
...
]
}
```
------
# listImageLog直播
检索与映像关联的日志流的列表。
**Topics**
+ [请求语法](#list-image-log-streams-request)
+ [请求正文](#list-image-log-streams-request-body)
+ [响应语法](#list-image-log-streams-response)
+ [响应正文](#list-image-log-streams-response-body)
+ [示例](#list-image-log-streams-example)
## 请求语法
```
GET /v3/images/custom/{imageId}/logstreams
{
"nextToken": "string",
"region": "string"
}
```
## 请求正文
**imageId**
映像的 ID。
类型：字符串。
必需：是
**nextToken**
用于获取下一组结果的令牌。
类型：字符串
必需：否
**region**
图像所在 AWS 区域 的那个。
类型：字符串
必需：否
## 响应语法
```
{
"nextToken": "string",
"logStreams": [
{
"logStreamName": "string",
"creationTime": "2019-08-24T14:15:22Z",
"firstEventTimestamp": "2019-08-24T14:15:22Z",
"lastEventTimestamp": "2019-08-24T14:15:22Z",
"lastIngestionTime": "2019-08-24T14:15:22Z",
"uploadSequenceToken": "string",
"logStreamArn": "string"
}
]
}
```
## 响应正文
**logStreams**
日志流的列表。
**creationTime**
创建流的时间。
类型：日期时间
**firstEventTimestamp**
流中第一个事件的时间。
类型：日期时间
**lastEventTimestamp**
流中最后一个事件的时间。该 lastEventTime 值以最终一致性为基础进行更新。它通常会在摄取后不到一小时内更新，但在极少数情况下可能需要更长时间。
类型：日期时间
**lastIngestionTime**
上次摄取时间。
类型：日期时间
**logStreamArn**
日志流的 Amazon 资源名称 (ARN)。
类型：字符串
**logStreamName**
日志流的名称。
类型：字符串
**uploadSequenceToken**
序列令牌。
类型：字符串
**next\$1token**
用于检索下一组结果的令牌，没有更多结果时为 `null`。
类型：字符串
## 示例
------
#### [ Python ]
**请求**
```
$ list_image_log_streams(custom-image-id)
```
**200 响应**
```
{
'log_streams': [
{
'creation_time': datetime.datetime(2022, 3, 29, 20, 29, 24, 875000, tzinfo=tzlocal()),
'first_event_timestamp': datetime.datetime(2022, 3, 29, 20, 29, 24, 775000, tzinfo=tzlocal()),
'last_event_timestamp': datetime.datetime(2022, 3, 29, 20, 38, 23, 944000, tzinfo=tzlocal()),
'last_ingestion_time': datetime.datetime(2022, 3, 29, 20, 51, 56, 26000, tzinfo=tzlocal()),
'log_stream_arn': 'arn:aws:logs:us-east-1:123456789012:log-group:/aws/imagebuilder/ParallelClusterImage-alinux2-image:log-stream:3.2.1/1',
'log_stream_name': '3.2.1/1',
'upload_sequence_token': '####'
},
...
]
}
```
------
# listImages
检索现有自定义映像的列表。
**Topics**
+ [请求语法](#list-images-request)
+ [请求正文](#list-images-request-body)
+ [响应语法](#list-images-response)
+ [响应正文](#list-images-response-body)
+ [示例](#list-images-example)
## 请求语法
```
GET /images/custom
{
"imageStatus": "string",
"nextToken": "string",
"region": "string"
}
```
## 请求正文
**imageStatus**
按提供的状态筛选映像。
类型：字符串
有效值：`AVAILABLE | PENDING | FAILED`
必需：是
**nextToken**
用于获取下一组结果的令牌。
类型：字符串
必需：否
**region**
AWS 区域 那张图片在里面。
类型：字符串
必需：否
## 响应语法
```
{
"nextToken": "string",
"images": [
{
"imageId": "string",
"ec2AmiInfo": {
"amiId": "string"
},
"region": "string",
"version": "string",
"cloudformationStackArn": "string",
"imageBuildStatus": "BUILD_IN_PROGRESS",
"cloudformationStackStatus": "CREATE_IN_PROGRESS"
}
]
}
```
## 响应正文
**images**
映像的列表。
**cloudformationStackArn**
主 CloudFormation 堆栈的亚马逊资源名称 (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`
**ec2 AmiInfo**
**ami\$1id**
亚马逊 EC2 AMI ID。
类型：字符串
**imageBuildStatus**
映像构建状态。
有效值：`BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE`
类型：字符串
**imageId**
映像的 ID。
类型：字符串
**区域**
AWS 区域 在其中创建镜像。
类型：字符串
**version**
用于构建镜像的 AWS ParallelCluster 版本。
类型：字符串
**nextToken**
用于检索下一组结果的令牌，没有更多结果时为 `null`。
类型：字符串
## 示例
------
#### [ Python ]
**请求**
```
$ list_images("AVAILABLE")
```
**200 响应**
```
{
'images': [
{
'ec2_ami_info': {
'ami_id': 'ami-abcdef01234567890'
},
'image_build_status': 'BUILD_COMPLETE',
'image_id': 'custom-image',
'region': 'us-east-1',
'version': '3.2.1'
}
]
}
```
------
# listOfficialImages
检索 AWS ParallelCluster 官方图片列表。
**Topics**
+ [请求语法](#list-official-images-request)
+ [请求正文](#list-official-images-request-body)
+ [响应语法](#list-official-images-response)
+ [响应正文](#list-official-images-response-body)
+ [示例](#list-official-images-example)
## 请求语法
```
GET /v3/images/official
{
"architecture": "string",
"os": "string",
"region": "string"
}
```
## 请求正文
**架构**
按架构筛选。默认为不筛选。
类型：字符串
有效值：`x86_64 | arm64`
必需：否
**os**
按操作系统分发进行筛选。默认为不筛选。
类型：字符串
有效值：`alinux2 | alinux2023 | ubuntu2404 | ubuntu2204 | rhel8 | rhel9`
必需：否
**region**
其中 AWS 区域 列出了官方图片。
类型：字符串
必需：否
## 响应语法
```
{
"images": [
{
"architecture": "string",
"amiId": "string",
"name": "string",
"os": "string",
"version": "string"
}
]
}
```
## 响应正文
**images**
**amiId**
AMI 的 ID。
类型：字符串
**架构**
AMI 架构。
类型：字符串
**名称**
AMI 的名称。
类型：字符串
**os**
AMI 操作系统。
类型：字符串
**version**
AWS ParallelCluster 版本。
类型：字符串
## 示例
------
#### [ Python ]
**请求**
```
$ list_official_images()
```
**200 响应**
```
{
'images': [
{
'ami_id': 'ami-015cfeb4e0d6306b2',
'architecture': 'x86_64',
'name': 'aws-parallelcluster-3.2.1-ubuntu-2204-lts-hvm-x86_64-202202261505 '
'2022-02-26T15-08-34.759Z',
'os': 'ubuntu2204',
'version': '3.2.1'
},
...
]
}
```
------
# updateCluster
更新集群。
**Topics**
+ [请求语法](#update-cluster-request)
+ [请求正文](#update-cluster-request-body)
+ [响应语法](#update-cluster-response)
+ [响应正文](#update-cluster-response-body)
+ [示例](#update-cluster-example)
## 请求语法
```
PUT /v3/clusters/{clusterName}
{
"clusterConfiguration": "string",
"dryrun": boolean,
"forceUpdate": boolean,
"region": "string",
"suppressValidators": "string",
"validationFailureLevel": "string"
}
```
## 请求正文
**clusterConfiguration**
集群配置作为 YAML 文档。
必需：是
**clusterName**
集群的名称。
类型：字符串。
必需：是
**dryrun**
如果设置为 `true`，则仅执行请求验证而不创建任何资源。使用此参数可验证集群配置和更新要求。默认值为 `false`。
类型：布尔值
必需：否
**forceUpdate**
如果设置为 `true`，则忽略更新验证错误并强制更新。默认值为 `false`。
类型：布尔值
必需：否
**region**
AWS 区域 集群所在的。
类型：字符串
必需：否
**suppressValidators**
标识一个或多个要禁止的配置验证器。
类型：字符串
格式：`(ALL|type:[A-Za-z0-9]+)`
必需：否
有效值示例：`currentValue`、`requestedValue`、`message`
**validationFailureLevel**
导致更新失败的最低验证级别。
类型：字符串
有效值：`INFO | WARNING | ERROR`
必需：否
## 响应语法
```
{
"cluster": {
"clusterName": "string",
"region": "string",
"version": "string",
"cloudformationStackArn": "string",
"cloudformationStackStatus": "UPDATE_IN_PROGRESS",
"clusterStatus": "UPDATE_IN_PROGRESS",
"scheduler": {
"type": "string",
"metadata": {
"name": "string",
"version": "string"
}
}
},
"validationMessages": [
{
"id": "string",
"type": "string",
"level": "INFO",
"message": "string"
}
],
"changeSet": [
{
"parameter": "string",
"currentValue": "string",
"requestedValue": "string"
}
]
}
```
## 响应正文
**changeSet**
集群更新的更改集。
**currentValue**
要更新的参数的当前值。
类型：字符串
**参数**
要更新的参数。
类型：字符串
**requestedValue**
要更新的参数的请求值。
类型：字符串
**cluster**
**cloudformationStackArn**
主 CloudFormation 堆栈的亚马逊资源名称 (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`
**区域**
AWS 区域 在其中创建集群。
类型：字符串
**scheduler**
**metadata**
调度器元数据。
**名称**
调度器的名称。
类型：字符串
**version**
调度器版本。
类型：字符串
**type**
调度器类型。
类型：字符串
**version**
AWS ParallelCluster 用于创建集群的版本。
类型：字符串
**validationMessages**
验证级别低于 `validationFailureLevel` 的消息的列表。消息列表是在配置验证期间收集的。
**id**
验证器的 ID。
类型：字符串
**level**
验证级别。
类型：字符串
有效值：`INFO | WARNING | ERROR`
**message**
验证消息。
类型：字符串
**type**
验证器的类型。
类型：字符串
## 示例
------
#### [ Python ]
**请求**
```
$ update_cluster(cluster_name_3x, path/config-file.yaml)
```
**200 响应**
```
{
'change_set': [
{
'current_value': '10',
'parameter': 'Scheduling.SlurmQueues[queue1].ComputeResources[t2micro].MaxCount',
'requested_value': '15'
}
],
'cluster': {
'cloudformation_stack_arn': 'arn:aws:cloudformation:us-east-1:123456789012:stack/test-api-cluster/e0462730-50b5-11ed-99a3-0a5ddc4a34c7',
'cloudformation_stack_status': 'UPDATE_IN_PROGRESS',
'cluster_name': 'cluster-3x',
'cluster_status': 'UPDATE_IN_PROGRESS',
'region': 'us-east-1',
'scheduler': {
'type': 'slurm'
},
'version': '3.2.1'
}
}
```
------
# updateComputeFleet
更新集群计算实例集的状态。
**Topics**
+ [请求语法](#update-compute-fleet-request)
+ [请求正文](#update-compute-fleet-request-body)
+ [响应语法](#update-compute-fleet-response)
+ [响应正文](#update-compute-fleet-response-body)
+ [示例](#update-compute-fleet-example)
## 请求语法
```
PATCH /v3/clusters/{clusterName}/computefleet
{
"status": "string",
"region": "string"
}
```
## 请求正文
**clusterName**
集群的名称。
类型：字符串。
必需：是
**状态**
计算实例集状态。
类型：字符串
有效值：`START_REQUESTED | STOP_REQUESTED | ENABLED | DISABLED`
必需：是
**区域**
AWS 区域 集群所在的。
类型：字符串
必需：否
## 响应语法
```
{
"status": "START_REQUESTED",
"lastStatusUpdatedTime": "2019-08-24T14:15:22Z"
}
```
## 响应正文
**状态**
计算实例集状态。
类型：字符串
有效值：`START_REQUESTED | STARTING | RUNNING | PROTECTED | STOP_REQUESTED | STOPPING | STOPPED | UNKNOWN | ENABLED | DISABLED`
**lastStatusUpdated时间**
代表上次状态更新时间的时间戳。
类型：日期时间
## 示例
------
#### [ Python ]
**请求**
```
$ update_compute_fleet(cluster_name_3x, "START_REQUESTED")
```
**200 响应**
```
{
'last_status_updated_time': datetime.datetime(2022, 3, 28, 22, 27, 14, tzinfo=tzlocal()),
'status': 'START_REQUESTED'
}
```
------