本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# describeImage
<a name="describe-image"></a>

获取有关现有映像的详细信息。

**Topics**
+ [请求语法](#describe-image-request)
+ [请求正文](#describe-image-request-body)
+ [响应语法](#describe-image-response)
+ [响应正文](#describe-image-response-body)
+ [示例](#describe-image-example)

## 请求语法
<a name="describe-image-request"></a>

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

## 请求正文
<a name="describe-image-request-body"></a>

**imageId**  
映像的 ID。  
类型：字符串。  
必需：是

**区域**  
图像 Amazon Web Services 区域 是在其中创建的。  
类型：字符串  
必需：否

## 响应语法
<a name="describe-image-response"></a>

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

## 响应正文
<a name="describe-image-response-body"></a>

**imageId**  
要检索其详细信息的映像的 ID。  
类型：字符串

**imageBuildStatus**  
映像构建状态。  
类型：字符串  
有效值：`BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE`

**imageConfiguration**    
**url**  
映像配置文件的 URL。  
类型：字符串

**区域**  
 Amazon Web Services 区域 在其中创建镜像。  
类型：字符串

**version**  
用于构建镜像的 Amazon ParallelCluster 版本。  
类型：字符串

**cloudformationStackArn**  
主 CloudFormation 堆栈的亚马逊资源名称 (ARN)。  
类型：字符串

**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 堆栈的标签列表。    
**键**  
标签名称。  
类型：字符串  
**value**  
标签值。  
类型：字符串

**creationTime**  
图像的创建时间。  
类型：日期时间

**ec2 AmiInfo**    
**amiId**  
亚马逊 EC2 AMI ID。  
类型：字符串  
**amiName**  
亚马逊 EC2 AMI 的名称。  
类型：字符串  
**架构**  
亚马逊 EC2 AMI 架构。  
类型：字符串  
**状态**  
亚马逊 EC2 AMI 的状态。  
类型：字符串  
有效值：`PENDING | AVAILABLE | INVALID | DEREGISTERED | TRANSIENT | FAILED | ERROR`  
**tags**  
亚马逊 EC2 AMI 标签列表。    
**key**  
标签名称。  
类型：字符串  
**值**  
标签值。  
类型：字符串

**imagebuilderImageStatus**  
 ImageBuilder 图像状态。  
类型：字符串  
有效值：`PENDING | CREATING | BUILDING | TESTING | DISTRIBUTING | INTEGRATING | AVAILABLE | CANCELLED | FAILED | DEPRECATED | DELETED`

**imagebuilderImageStatus原因**  
 ImageBuilder 图片处于该状态的原因。  
类型：字符串

**imageBuildLogsArn**  
映像构建过程日志的 Amazon 资源名称 (ARN)。  
类型：字符串

## 示例
<a name="describe-image-example"></a>

------
#### [ Python ]

**请求**

```
$ describe_image({{custom-image-id}})
```

**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-alinux2-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"
}
```

------