描述圖片

取得有關現有映像檔的詳細資訊。

請求語法

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

請求內文

imageId

影像的識別碼。

類型：字串

必要：是

region

該AWS 區域圖像是在中創建的。

類型：字串

必要：否

回應語法

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

回應內文

imageId

要擷取詳細資訊的影像 ID。

類型：字串

imageBuildStatus

映像建置狀態。

類型：字串

有效值：BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE

映像配置

url

映像檔組態檔的 URL。

類型：字串

region

該AWS 區域該圖像是在中創建的。

類型：字串

版本

該AWS ParallelCluster用於構建映像的版本。

類型：字串

cloudformationStackArn

主要的亞馬遜資源名稱（ARN） CloudFormation 堆疊。

類型：字串

cloudformationStackCreation時間

時間戳記 CloudFormation 已建立堆疊。

類型：日期時間

cloudformationStackStatus

該 CloudFormation 堆疊狀態。

類型：字串

有效值：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

cloudformationStackStatus原因

的原因 CloudFormation 堆疊狀態。

類型：字串

cloudformationStackTags

的標籤列表 CloudFormation 堆疊。

key

標籤名稱。

類型：字串

value

標籤值。

類型：字串

creationTime

建立影像時的時間戳記。

類型：日期時間

ec2AmiInfo

阿米德

EC2 的 AMI 識別碼。

類型：字串

阿米娜美

EC2 AMI 名稱。

類型：字串

架構

EC2 AMI 架構。

類型：字串

狀態

EC2 AMI 的狀態。

類型：字串

有效值：PENDING | AVAILABLE | INVALID | DEREGISTERED | TRANSIENT | FAILED | ERROR

tags

EC2 AMI 標籤的列表。

key

標籤名稱。

類型：字串

value

標籤值。

類型：字串

imagebuilderImageStatus

該 ImageBuilder 狀態。

類型：字串

有效值：PENDING | CREATING | BUILDING | TESTING | DISTRIBUTING | INTEGRATING | AVAILABLE | CANCELLED | FAILED | DEPRECATED | DELETED

imagebuilderImageStatus原因

的原因 ImageBuilder 影像狀態。

類型：字串

imageBuildLogs阿恩

映像檔建置程序的日誌的亞馬遜資源名稱 (ARN)。

類型：字串

範例

Python

請求

$ describe_image(custom-image-id)

二百個回應

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