本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
適用於邊緣裝置的僅AWS IoT SiteWise邊緣 API
除了邊緣上可用的 AWS IoT SiteWise API 之外,還有特定於邊緣的 API。這些邊緣特定的 API 如下所述。
驗證
從 SiteWise Edge 閘道取得認證。您需要新增本機使用者或使用 LDAP 或 Linux 使用者集區連線到您的系統。如需有關新增使用者的詳細資訊,請參閱 LDAP 或 Linux 使用者集區。
請求語法
POST /authenticate HTTP/1.1 Content-type: application/json { "username": "string", "password": "string", "authMechanism": "string" }
URI 請求參數
請求不會使用任何 URI 參數。
請求內文
請求接受採用 JSON 格式的下列資料。
- 用戶名
-
用來驗證要求呼叫的使用者名稱。
類型:字串
必要:是
- 密碼
-
要求認證的使用者密碼。
類型:字串
必要:是
- 授權機制
-
驗證主機中此使用者的驗證方法。
類型:字串
有效值:
ldap
、linux
、winnt
必要:是
回應語法
HTTP/1.1 200 Content-type: application/json { "accessKeyId": "string", "secretAccessKey": "string", "sessionToken": "string", "region": "edge" }
回應元素
如果動作成功,則服務傳回 HTTP 200 回應。
以下數據以 JSON 格式返回。
- accessKeyId
-
識別臨時安全登入資料的存取金鑰 ID。
長度約束:最小長度為 16。長度上限為 128。
模式:
[\w]*
- secretAccessKey
-
可用來簽署要求的秘密存取金鑰。
類型:字串
- sessionToken
-
用戶必須傳遞給服務 API 才能使用臨時憑據的令牌。
類型:字串
- region
-
您要進行 API 呼叫的目標區域。
類型:常數-
edge
錯誤
- IllegalArgumentException
-
請求被拒絕,因為提供的主體文件格式不正確。錯誤消息描述了特定錯誤。
HTTP 狀態碼:400
- AccessDeniedException
-
使用者沒有以目前身分識別提供者為基礎的有效認證。錯誤消息描述了身份驗證機制。
HTTP 狀態碼:403
- TooManyRequestsException
-
請求已達到身份驗證嘗試的限制。錯誤訊息包含新嘗試驗證之前等待的時間量。
HTTP 狀態碼:429