listImages - AWS ParallelCluster

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

listImages

检索现有自定义映像的列表。

请求语法

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 堆栈的 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

ec2AmiInfo
ami_id

EC2 AMI ID。

类型:字符串

imageBuildStatus

映像构建状态。

有效值:BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE

类型:字符串

imageId

映像的 ID。

类型:字符串

region

在其中创建映像的 AWS 区域。

类型:字符串

version

用于构建映像的 AWS ParallelCluster 版本。

类型:字符串

nextToken

用于分页请求的令牌。

类型:字符串

示例

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