DescribeImage

Dapatkan informasi rinci tentang gambar yang ada.

Sintaksis Permintaan

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

Isi permintaan

imageId

ID gambar.

Tipe: string

Diperlukan: Ya

region

Di Wilayah AWS mana gambar itu dibuat.

Jenis: string

Wajib: Tidak

Sintaksis Respons

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

Isi respons

imageId

ID gambar untuk mengambil informasi rinci untuk.

Jenis: string

imageBuildStatus

Status pembuatan gambar.

Jenis: string

Nilai yang valid: BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE

ImageConfiguration

url

URL dari file konfigurasi gambar.

Jenis: string

region

Di Wilayah AWS mana gambar dibuat.

Jenis: string

versi

AWS ParallelCluster Versi yang digunakan untuk membangun gambar.

Jenis: string

cloudformationStackArn

Nama Sumber Daya Amazon (ARN) dari tumpukan utama CloudFormation .

Jenis: string

cloudformationStackCreationWaktu

Stempel waktu untuk saat CloudFormation tumpukan dibuat.

Jenis: datetime

cloudformationStackStatus

Status CloudFormation tumpukan.

Jenis: string

Nilai yang valid: 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

cloudformationStackStatusAlasan

Alasan status CloudFormation tumpukan.

Jenis: string

cloudformationStackTags

Daftar tag untuk CloudFormation tumpukan.

kunci

Nama tag.

Jenis: string

nilai

Nilai tanda.

Jenis: string

CreationTime

Stempel waktu untuk saat gambar dibuat.

Jenis: datetime

ec2 AmiInfo

AmiID

ID AMI Amazon EC2.

Jenis: string

Aminame

Nama Amazon EC2 AMI.

Jenis: string

arsitektur

Arsitektur AMI Amazon EC2.

Jenis: string

status

Keadaan Amazon EC2 AMI.

Jenis: string

Nilai yang valid: PENDING | AVAILABLE | INVALID | DEREGISTERED | TRANSIENT | FAILED | ERROR

tag

Daftar Tag AMI Amazon EC2.

kunci

Nama tag.

Jenis: string

nilai

Nilai tag.

Jenis: string

imagebuilderImageStatus

ImageBuilder Status.

Jenis: string

Nilai yang valid: PENDING | CREATING | BUILDING | TESTING | DISTRIBUTING | INTEGRATING | AVAILABLE | CANCELLED | FAILED | DEPRECATED | DELETED

imagebuilderImageStatusAlasan

Alasan untuk status ImageBuilder Gambar.

Jenis: string

imageBuildLogsArn

Nama Sumber Daya Amazon (ARN) dari log untuk proses pembuatan gambar.

Jenis: string

Contoh

Python

Permintaan

$ describe_image(custom-image-id)

200 Respon

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