

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

# AWS ParallelCluster API
<a name="api-reference-v3"></a>

**什麼是 AWS ParallelCluster API？**

AWS ParallelCluster API 是一種無伺服器應用程式，一旦部署到您的 AWS 帳戶，即可透過 API 以程式設計方式存取 AWS ParallelCluster 功能。

AWS ParallelCluster API 是以包含 [Amazon API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/welcome.html) 端點的獨立[CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html)範本進行分佈，該端點會公開 AWS ParallelCluster 功能和 [AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/welcome.html)函數，負責處理調用的功能。

下圖顯示 AWS ParallelCluster API 基礎設施的高階架構圖。

 ![a high-level architecture diagram of the ParallelCluster API infrastructure](http://docs.aws.amazon.com/zh_tw/parallelcluster/latest/ug/images/API-Architecture-r2.png) 

## AWS ParallelCluster API 文件
<a name="api-reference-documentation-v3"></a>

描述 AWS ParallelCluster API 的 OpenAPI 規格檔案可從下列位置下載：

```
https://{{<REGION>}}-aws-parallelcluster.s3.{{<REGION>}}.amazonaws.com/parallelcluster/{{<VERSION>}}/api/ParallelCluster.openapi.yaml
```

從 OpenAPI 規格檔案開始，您可以使用 [ Swagger UI ](https://swagger.io/tools/swagger-ui/)或 [Redoc](https://github.com/Redocly/redoc) 等許多可用工具之一來產生 AWS ParallelCluster API 的文件。

**如何部署 AWS ParallelCluster API**

若要部署 AWS ParallelCluster API，您必須是 的管理員 AWS 帳戶。

用於部署 API 的範本可在下列 URL 取得：

```
https://{{<REGION>}}-aws-parallelcluster.s3.{{<REGION>}}.amazonaws.com/parallelcluster/{{<VERSION>}}/api/parallelcluster-api.yaml
```

其中 `{{<REGION>}}`是 API 需要部署到 AWS 區域 其中的 ，而 `{{<VERSION>}}`是 AWS ParallelCluster 版本 （例如 3.15.1)。

AWS Lambda 使用 Lambda layer 界面搭配 [AWS ParallelCluster Python 程式庫 API](pc-py-library-v3.md)來處理 API 調用的功能。

**警告**  
中 AWS 帳戶具有 AWS Lambda 或 Amazon API Gateway 服務權限的任何使用者，會自動繼承管理 AWS ParallelCluster API 資源的許可。