View a markdown version of this page

Décrire l'image - AWS ParallelCluster
Syntaxe de demandeCorps de la requêteSyntaxe de réponseCorps de la réponseExemple

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Décrire l'image

Obtenez des informations détaillées sur une image existante.

Syntaxe de demande

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

Corps de la requête

imageId

L'ID de l'image.

Type : chaîne

Obligatoire : oui

region

L' Région AWS endroit dans lequel l'image a été créée.

Type : chaîne

Obligatoire : non

Syntaxe de réponse

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

Corps de la réponse

imageId

L'ID de l'image pour laquelle vous souhaitez récupérer des informations détaillées.

Type : chaîne

image BuildStatus

État de création de l'image.

Type : chaîne

Valeurs valides : BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE

Configuration de l'image
url

URL du fichier de configuration de l'image.

Type : chaîne

region

L' Région AWS endroit dans lequel l'image est créée.

Type : chaîne

version

AWS ParallelCluster Version utilisée pour créer l'image.

Type : chaîne

formation des nuages StackArn

Le nom de ressource Amazon (ARN) de la CloudFormation pile principale.

Type : chaîne

formation des nuages StackCreationTime

Heure à laquelle la CloudFormation pile a été créée.

Type : datetime

formation des nuages StackStatus

L'état de la CloudFormation pile.

Type : chaîne

Valeurs valides : 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

formation des nuages StackStatusReason

Raison de l'état de la CloudFormation pile.

Type : chaîne

formation des nuages StackTags

La liste des balises de la CloudFormation pile.

clé

Le nom de la balise.

Type : chaîne

value

Valeur de balise.

Type : chaîne

creationTime

L'heure à laquelle l'image a été créée.

Type : datetime

ec2 AmiInfo
ID AMI

L'ID AMI Amazon EC2.

Type : chaîne

Nom de l'ami

Le nom de l'AMI Amazon EC2.

Type : chaîne

application

L'architecture AMI Amazon EC2.

Type : chaîne

state

État de l'AMI Amazon EC2.

Type : chaîne

Valeurs valides : PENDING | AVAILABLE | INVALID | DEREGISTERED | TRANSIENT | FAILED | ERROR

tags

Liste des balises AMI Amazon EC2.

clé

Nom du tag.

Type : chaîne

value

Valeur de la balise.

Type : chaîne

générateur d'images ImageStatus

État de ImageBuilder l'image.

Type : chaîne

Valeurs valides : PENDING | CREATING | BUILDING | TESTING | DISTRIBUTING | INTEGRATING | AVAILABLE | CANCELLED | FAILED | DEPRECATED | DELETED

générateur d'images ImageStatusReason

La raison pour laquelle l' ImageBuilder image a ce statut.

Type : chaîne

image BuildLogsArn

Le nom de ressource Amazon (ARN) des journaux du processus de création de l'image.

Type : chaîne

Exemple

Python

Demande

$ describe_image(custom-image-id)

Réponse 200 

{
  "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:amzn-s3-demo-bucket",
      "value": 'amzn-s3-demo-bucket"
    },
    {
      "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://amzn-s3-demo-bucket/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-custom-image",
  "image_build_status": "BUILD_IN_PROGRESS",
  "image_configuration": {
    "url": "https://amzn-s3-demo-bucket.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"
}