View a markdown version of this page

Beschreiben Sie das Bild - AWS ParallelCluster
Erforderliche SyntaxAnforderungstextAntwortsyntaxAntworttextBeispiel

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Beschreiben Sie das Bild

Ruft detaillierte Informationen über ein vorhandenes Bild ab.

Erforderliche Syntax

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

Anforderungstext

imageId

Die ID des Bildes.

Type: Zeichenkette

Erforderlich: Ja

Region

Die, AWS-Region in der das Bild erstellt wurde.

Type: Zeichenkette

Erforderlich: Nein

Antwortsyntax

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

Antworttext

imageId

Die ID des Bilds, für das detaillierte Informationen abgerufen werden sollen.

Type: Zeichenkette

Bild BuildStatus

Der Status der Image-Erstellung.

Type: Zeichenkette

Zulässige Werte: BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE

Image-Konfiguration
URL

Die URL der Image-Konfigurationsdatei.

Type: Zeichenkette

Region

Die, AWS-Region in der das Bild erstellt wird.

Type: Zeichenkette

version

Die AWS ParallelCluster Version, die zum Erstellen des Images verwendet wird.

Type: Zeichenkette

Wolkenbildung StackArn

Der Amazon-Ressourcenname (ARN) des CloudFormation Hauptstapels.

Type: Zeichenkette

Wolkenbildung StackCreationTime

Der Zeitpunkt, zu dem der CloudFormation Stapel erstellt wurde.

Typ: DateTime

Wolkenbildung StackStatus

Der CloudFormation Stack-Status.

Type: Zeichenkette

Zulässige Werte: 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

Wolkenbildung StackStatusReason

Der Grund für den CloudFormation Stack-Status.

Type: Zeichenkette

Wolkenbildung StackTags

Die Liste der Tags für den CloudFormation Stack.

Schlüssel

Der Tag-Name.

Type: Zeichenkette

value

Der Tag-Wert.

Type: Zeichenkette

creationTime

Die Zeiten, zu denen das Bild erstellt wurde.

Typ: DateTime

ec2 AmiInfo
Bin ich

Die Amazon EC2-AMI-ID.

Type: Zeichenkette

AMIName

Der Amazon EC2-AMI-Name.

Type: Zeichenkette

Architektur

Die Amazon EC2-AMI-Architektur.

Type: Zeichenkette

state

Der Status des Amazon EC2-AMI.

Type: Zeichenkette

Zulässige Werte: PENDING | AVAILABLE | INVALID | DEREGISTERED | TRANSIENT | FAILED | ERROR

tags

Liste der Amazon EC2-AMI-Tags.

Schlüssel

Tag-Name.

Type: Zeichenkette

value

Tag-Wert.

Type: Zeichenkette

Imagebuilder ImageStatus

Der ImageBuilder Image-Status.

Type: Zeichenkette

Zulässige Werte: PENDING | CREATING | BUILDING | TESTING | DISTRIBUTING | INTEGRATING | AVAILABLE | CANCELLED | FAILED | DEPRECATED | DELETED

Imagebuilder ImageStatusReason

Der Grund, warum das ImageBuilder Image diesen Status hat.

Type: Zeichenkette

Bild BuildLogsArn

Der Amazon-Ressourcenname (ARN) der Protokolle für den Image-Erstellungsprozess.

Type: Zeichenkette

Beispiel

Python

Anforderung

$ describe_image(custom-image-id)

200 Antwort 

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