本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
仅适用于边缘的 APIAmazon IoT SiteWise边缘设备
除了Amazon IoT SiteWise边缘上可用的 API 也有特定于边缘的 API。这些边缘特定的 API 如下所述。
进行身份验证
从网关获取证书。您需要添加本地用户或使用 LDAP 或 Linux 用户池连接到您的系统。有关添加用户的更多信息,请参阅LDAP要么Linux 用户池。
请求语法
POST /authenticate HTTP/1.1 Content-type: application/json { "username": "string", "password": "string", "authMechanism": "string" }
URI 请求参数
该请求不使用任何 URI 参数。
请求正文
请求接受采用 JSON 格式的以下数据。
- username
-
用于验证请求调用的用户名。
类型:字符串
必需:是
- password
-
请求凭证的用户的密码。
类型:字符串
必需:是
- authMechanism
-
在主机中验证此用户的身份验证方法。
类型:字符串
有效值:
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 才能使用临时证书的令牌。
类型:字符串
- 区域
-
您针对 API 调用的目标区域。
类型:常数-
edge
错误
- IllegalArgumentException
-
由于提供的正文文件格式错误,请求被拒绝。错误消息描述了具体的错误。
HTTP 状态代码:400
- AccessDeniedException
-
根据当前的身份提供商,用户没有有效的凭证。错误消息描述了身份验证机制。
HTTP 状态代码:403
- TooManyRequestsException
-
该请求已达到其身份验证尝试次数的上限。错误消息包含等待进行新的身份验证尝试的时间。
HTTP 状态代码:429