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

# 與邊緣裝置搭配使用的僅限 AWS IoT SiteWise APIs
<a name="edge-local-apis"></a>

除了邊緣上可用的 AWS IoT SiteWise APIs 之外，還有特定邊緣的 API。這些邊緣規格 APIs 如下所述。

## 驗證
<a name="edge-local-apis-authenticate"></a>

從 SiteWise Edge 閘道取得憑證。您需要新增本機使用者，或使用 LDAP 或 Linux 使用者集區連線到您的系統。如需新增使用者的詳細資訊，請參閱 [LDAP](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/manage-gateways-ggv2.html#opshub-app) 或 [Linux 使用者集區](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/manage-gateways-ggv2.html#opshub-app)。

### 請求語法
<a name="authenticate-request-syntax"></a>

```
POST /authenticate HTTP/1.1
Content-type: application/json
{
  "username": "string",
  "password": "string",
  "authMechanism": "string"
}
```

### URI 請求參數
<a name="authenticate-request-parameters"></a>

請求不會使用任何 URI 參數。

### 請求內文
<a name="authenticate-request-body"></a>

請求接受採用 JSON 格式的下列資料。

**使用者名稱**  
用來驗證請求呼叫的使用者名稱。  
類型：字串  
必要：是

**password**  
請求登入資料之使用者的密碼。  
類型：字串  
必要：是

**authMechanism**  
在主機中驗證此使用者的身分驗證方法。  
類型：字串  
有效值：`ldap`、`linux`、`winnt`  
必要：是

### 回應語法
<a name="authenticate-response-syntax"></a>

```
HTTP/1.1 200
Content-type: application/json
{
  "accessKeyId": "string",
  "secretAccessKey": "string",
  "sessionToken": "string",
  "region": "edge"
}
```

### 回應元素
<a name="authenticate-response-elements"></a>

如果動作成功，則服務傳回 HTTP 200 回應。

下列資料會以 JSON 格式傳回。

**accessKeyId**  
識別暫時安全登入資料的存取金鑰 ID。  
長度限制：長度下限為 16。長度上限為 128。  
模式：`[\w]*`

**secretAccessKey**  
可用來簽署請求的私密存取金鑰。  
類型：字串

**sessionToken**  
使用者必須傳遞至服務 API 才能使用臨時登入資料的字符。  
類型：字串

**region**  
您為 API 呼叫設定目標的區域。  
類型：CONSTANT - `edge`

### 錯誤
<a name="authenticate-errors"></a>

**IllegalArgumentException**  
請求被拒絕，因為提供的內文文件格式不正確。錯誤訊息說明特定錯誤。  
HTTP 狀態碼：400

**AccessDeniedException**  
根據目前的身分提供者，使用者沒有有效的登入資料。錯誤訊息說明身分驗證機制。  
HTTP 狀態碼：403

**TooManyRequestsException**  
請求已達到其身分驗證嘗試的限制。錯誤訊息包含等待直到進行新的身分驗證嘗試的時間量。  
HTTP 狀態碼：429