BuildImage

Crea un file personalizzatoAWS ParallelClusterimmagine in unRegione AWS.

Sintassi della richiesta

POST /v3/images/custom
{
  "imageConfiguration": "string",
  "imageId": "string",
  "dryrun": boolean,
  "region": "string",
  "rollbackOnFailure": boolean,
  "supressValidators": [ "string" ],
  "validationFailureLevel": "string"
}

Corpo della richiesta

Configurazione dell'immagine

La configurazione dell'immagine come documento YAML.

Tipo: stringa

Campo obbligatorio: sì

imageId

L'ID dell'immagine da creare.

Tipo: stringa

Campo obbligatorio: sì

corsa a secco

Se impostato sutrue, esegue solo la convalida della richiesta senza creare alcuna risorsa. Utilizzate questo parametro per convalidare la configurazione dell'immagine. Il valore predefinito è false.

Tipo: booleano

Campo obbligatorio: no

Regione

LaRegione AWSin cui si esegue il comando per creare l'immagine.

Tipo: stringa

Campo obbligatorio: no

rollbackOnFailure

Se impostato sutrue, il rollback dello stack di immagini si verifica se l'immagine non viene creata. Il valore predefinito è false.

Tipo: booleano

Campo obbligatorio: no

Sopprimere i validatori

Identifica uno o più validatori di configurazione da sopprimere.

Tipo: elenco di stringhe

Formato: (ALL|type:[A-Za-z0-9]+)

Campo obbligatorio: no

validationFailureLevel

Il livello di convalida minimo che causa il fallimento della creazione dell'immagine. Il valore predefinito è ERROR.

Tipo: stringa

Valori validi: INFO | WARNING | ERROR

Campo obbligatorio: no

Sintassi della risposta

{
  "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"
    }
  ]
}

Corpo di risposta

image

imageId

L'ID dell'immagine.

Tipo: stringa

cloudformationStackArn

L'Amazon Resource Name (ARN) del principale CloudFormation pila.

Tipo: stringa

cloudformationStackStatus

La CloudFormation stato dello stack.

Tipo: stringa

Valori validi: 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

L'ID AMI EC2.

Tipo: stringa

imageBuildStatus

Lo stato di creazione dell'immagine.

Tipo: stringa

Valori validi: BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE

Regione

LaRegione AWSche l'immagine è integrata.

Tipo: stringa

versione

LaAWS ParallelClusterversione utilizzata per creare l'immagine.

Tipo: stringa

Messaggi di convalida

Un elenco di messaggi con un livello di convalida inferiore avalidationFailureLevel. L'elenco dei messaggi viene raccolto durante la convalida della configurazione.

id

L'ID del validatore.

Tipo: stringa

level

Il livello di convalida.

Tipo: stringa

Valori validi: INFO | WARNING | ERROR

message

Un messaggio di convalida.

Tipo: stringa

type

Il tipo di validatore.

Tipo: stringa

Esempio

Python

Richiesta

$ build_image(custom-image-id, custom-image-config.yaml)

200 Risposta

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