本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
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 堆栈的亚马逊资源名称 (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_id
-
亚马逊 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
-
用于分页请求的令牌。
类型：字符串
示例
请求
$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'
}
]
}