buildImage

在 AWS 区域 中创建自定义 AWS ParallelCluster 映像。

请求语法

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

region

在其中构建映像的 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'
  }
}