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

# listOfficialImages
<a name="list-official-images"></a>

检索 AWS ParallelCluster 官方图片列表。

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

## 请求语法
<a name="list-official-images-request"></a>

```
GET /v3/images/official
{  
  "architecture": "string",
  "os": "string",
  "region": "string"
}
```

## 请求正文
<a name="list-official-images-request-body"></a>

**架构**  
按架构筛选。默认为不筛选。  
类型：字符串  
有效值：`x86_64 | arm64`  
必需：否

**os**  
按操作系统分发进行筛选。默认为不筛选。  
类型：字符串  
有效值：`alinux2 | alinux2023 | ubuntu2404 | ubuntu2204 | rhel8 | rhel9`  
必需：否

**region**  
其中 AWS 区域 列出了官方图片。  
类型：字符串  
必需：否

## 响应语法
<a name="list-official-images-response"></a>

```
{
  "images": [
    {
      "architecture": "string",
      "amiId": "string",
      "name": "string",
      "os": "string",
      "version": "string"
    }
  ]
}
```

## 响应正文
<a name="list-official-images-response-body"></a>

**images**    
**amiId**  
AMI 的 ID。  
类型：字符串  
**架构**  
AMI 架构。  
类型：字符串  
**名称**  
AMI 的名称。  
类型：字符串  
**os**  
AMI 操作系统。  
类型：字符串  
**version**  
 AWS ParallelCluster 版本。  
类型：字符串

## 示例
<a name="list-official-images-example"></a>

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

**请求**

```
$ list_official_images()
```

**200 响应**

```
{
  'images': [ 
    {
      'ami_id': 'ami-015cfeb4e0d6306b2',
      'architecture': 'x86_64',
      'name': 'aws-parallelcluster-3.2.1-ubuntu-2204-lts-hvm-x86_64-202202261505 '
      '2022-02-26T15-08-34.759Z',
      'os': 'ubuntu2204',
      'version': '3.2.1'
    },
    ...
  ]
}
```

------