Descrivi l'immagine

Ottieni informazioni dettagliate su un'immagine esistente.

Sintassi della richiesta

GET /v3/images/custom/{imageId}
{
  "region": "string"
}

Corpo della richiesta

imageId

L'ID dell'immagine.

Tipo: stringa

Campo obbligatorio: sì

Regione

Regione AWS Quello in cui è stata creata l'immagine.

Tipo: stringa

Campo obbligatorio: no

Sintassi della risposta

{
  "imageId": "string",
  "region": "string",
  "version": "string",
  "imageBuildStatus": "BUILD_IN_PROGRESS",
  "imageBuildLogsArn": "string",
  "cloudformationStackStatus": "CREATE_IN_PROGRESS",
  "cloudformationStackStatusReason": "string",
  "cloudformationStackArn": "string",
  "creationTime": "2019-08-24T14:15:22Z",
  "cloudformationStackCreationTime": "2019-08-24T14:15:22Z",
  "cloudformationStackTags": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "imageConfiguration": {
    "url": "string"
  },
  "imagebuilderImageStatus": "PENDING",
  "imagebuilderImageStatusReason": "string",
  "ec2AmiInfo": {
    "amiId": "string",
    "tags": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "amiName": "string",
    "architecture": "string",
    "state": "PENDING",
    "description": "string"
  }
}

Corpo di risposta

imageId

L'ID dell'immagine per cui recuperare informazioni dettagliate.

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

Configurazione dell'immagine

url

L'URL del file di configurazione dell'immagine.

Tipo: stringa

Regione

Il formato in Regione AWS cui viene creata l'immagine.

Tipo: stringa

version

La AWS ParallelCluster versione utilizzata per creare l'immagine.

Tipo: stringa

cloudformationStackArn

L'Amazon Resource Name (ARN) dello stack principale CloudFormation .

Tipo: stringa

cloudformationStackCreationOra

Il timestamp di quando è stato creato lo CloudFormation stack.

Tipo: datetime

cloudformationStackStatus

Lo 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

cloudformationStackStatusMotivo

Il motivo dello stato dello CloudFormation stack.

Tipo: stringa

cloudformationStackTags

L'elenco dei tag per lo CloudFormation stack.

Chiave

Il nome del tag.

Tipo: stringa

value

Il valore del tag.

Tipo: stringa

creationTime

Timestamp di quando l'immagine è stata creata.

Tipo: datetime

ec2 AmiInfo

ID AM

L'ID AMI Amazon EC2.

Tipo: stringa

Un nome

Il nome AMI Amazon EC2.

Tipo: stringa

architecture

L'architettura AMI Amazon EC2.

Tipo: stringa

stato

Lo stato dell'AMI Amazon EC2.

Tipo: stringa

Valori validi: PENDING | AVAILABLE | INVALID | DEREGISTERED | TRANSIENT | FAILED | ERROR

tags

Elenco dei tag AMI di Amazon EC2.

Chiave

Nome del tag.

Tipo: stringa

value

Valore del tag.

Tipo: stringa

imagebuilderImageStatus

Lo ImageBuilder stato.

Tipo: stringa

Valori validi: PENDING | CREATING | BUILDING | TESTING | DISTRIBUTING | INTEGRATING | AVAILABLE | CANCELLED | FAILED | DEPRECATED | DELETED

imagebuilderImageStatusMotivo

Motivo dello stato ImageBuilder dell'immagine.

Tipo: stringa

imageBuildLogsArn

L'Amazon Resource Name (ARN) dei log per il processo di creazione dell'immagine.

Tipo: stringa

Esempio

Python

Richiesta

$ describe_image(custom-image-id)

200 Risposta

{
  'cloudformation_stack_arn': 'arn:aws:cloudformation:us-east-1:123456789012:stack/custom-image-id/6accc570-b080-11ec-845e-0e2dc6386985',
  'cloudformation_stack_creation_time': datetime.datetime(2022, 3, 30, 23, 23, 33, 731000, tzinfo=tzlocal()),
  'cloudformation_stack_status': 'CREATE_IN_PROGRESS',
  'cloudformation_stack_tags': [
    {
      'key': 'parallelcluster:version', 'value': '3.2.1'
    },
    {
      'key': 'parallelcluster:image_name',
      'value': 'custom-image-id'
    },
    {
      'key': 'parallelcluster:custom-image-id',
      'value': 'custom-image-id'
    },
    {
      'key': 'parallelcluster:s3_bucket',
      'value': 'parallelcluster-abcdef01234567890-v1-do-not-delete'
    },
    {
      'key': 'parallelcluster:s3_image_dir',
      'value': 'parallelcluster/3.2.1/images/custom-image-id-1234567890abcdef0'
    },
    {
      'key': 'parallelcluster:build_log',
      'value': 'arn:aws:logs:us-east-1:123456789012:log-group:/aws/imagebuilder/ParallelClusterImage-custom-image-id'
    },
    {
      'key': 'parallelcluster:build_config',
      'value': 's3://parallelcluster-abcdef01234567890-v1-do-not-delete/parallelcluster/3.2.1/images/custom-image-id-1234567890abcdef0/configs/image-config.yaml'
    }
  ],
  'image_build_logs_arn': 'arn:aws:logs:us-east-1:123456789012:log-group:/aws/imagebuilder/ParallelClusterImage-alinux2-image',
  'image_build_status': 'BUILD_IN_PROGRESS',
  'image_configuration': {
    'url': 'https://parallelcluster-abcdef01234567890-v1-do-not-delete.s3.amazonaws.com/parallelcluster/3.2.1/images/custom-image-id-1234567890abcdef0/configs/image-config.yaml?...'
  },
  'image_id': 'custom-image-id',
  'imagebuilder_image_status': 'PENDING',
  'region': 'us-east-1',
  'version': '3.2.1'
}