本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# 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 架構。  
類型：字串  
**name**  
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'
    },
    ...
  ]
}
```

------