deleteImage

开始删除自定义 AWS ParallelCluster 映像。

请求语法

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

amiId

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 版本。

类型：字符串

示例

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