API de solo periferia para uso con dispositivos AWS IoT SiteWise de periferia

Además de las API de AWS IoT SiteWise que están disponibles en la periferia, hay otras específicas de periferia. A continuación se describen esas API específicas de periferia.

Autenticación

Obtiene las credenciales de la puerta de enlace SiteWise Edge. Tendrá que añadir usuarios locales o conectarse a su sistema utilizando LDAP o un grupo de usuarios de Linux. Para obtener más información sobre cómo añadir usuarios, consulte LDAP o Grupo de usuarios de Linux.

Sintaxis de la solicitud

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

Parámetros de solicitud del URI

La solicitud no utiliza ningún parámetro de URI.

Cuerpo de la solicitud

La solicitud acepta los siguientes datos en formato JSON.

username

El nombre de usuario utilizado para validar la llamada de solicitud.

Tipo: cadena

Obligatorio: sí

password

La contraseña del usuario que solicita las credenciales.

Tipo: cadena

Obligatorio: sí

authMechanism

El método de autenticación para validar a este usuario en el host.

Tipo: cadena

Valores válidos: ldap, linux, winnt

Obligatorio: sí

Sintaxis de la respuesta

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

Elementos de respuesta

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

Los siguientes datos se devuelven en formato JSON.

accessKeyId

El ID de clave de acceso que identifica las credenciales de seguridad temporales.

Restricciones de longitud: longitud mínima de 16. La longitud máxima es de 128.

Patrón: [\w]*

secretAccessKey

La clave de acceso secreta que se puede utilizar para firmar las solicitudes.

Tipo: cadena

sessionToken

El token que los usuarios deben pasar a la API de servicio para utilizar las credenciales temporales.

Tipo: cadena

región

La región a la que se dirigen las llamadas a la API.

Tipo: CONSTANT - edge

Errores

IllegalArgumentException

La solicitud ha sido rechazada porque el formato del cuerpo del documento proporcionado no era correcto. El mensaje de error describe el error específico.

Código de estado HTTP: 400

AccessDeniedException

El usuario no tiene credenciales válidas basadas en el proveedor de identidad actual. El mensaje de error describe el mecanismo de autenticación.

Código de estado HTTP: 403

TooManyRequestsException

La solicitud ha alcanzado su límite de intentos de autenticación. El mensaje de error contiene la cantidad de tiempo de espera hasta que se realicen nuevos intentos de autenticación.

Código de estado HTTP: 429