API edge-only da utilizzare con dispositivi edge AWS IoT SiteWise - AWS IoT SiteWise
Autenticazione

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

API edge-only da utilizzare con dispositivi edge AWS IoT SiteWise

Oltre alle AWS IoT SiteWise API disponibili sull'edge, ne esistono di specifiche. Queste API specifiche per l'edge sono descritte di seguito.

Autenticazione

Ottiene le credenziali dal gateway SiteWise Edge. Dovrai aggiungere utenti locali o connetterti al sistema tramite LDAP o un pool di utenti Linux. Per ulteriori informazioni sull'aggiunta di utenti, consulta LDAP o pool di utenti Linux.

Sintassi della richiesta

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

Parametri di richiesta URI

La richiesta non utilizza parametri URI.

Corpo della richiesta

La richiesta accetta i seguenti dati in formato JSON.

username

Il nome utente utilizzato per convalidare la chiamata di richiesta.

Tipo: stringa

Campo obbligatorio: sì

password

La password dell'utente che richiede le credenziali.

Tipo: stringa

Campo obbligatorio: sì

Meccanismo di autenticazione

Il metodo di autenticazione per convalidare questo utente nell'host.

Tipo: stringa

Valori validi: ldap, linux, winnt

Campo obbligatorio: sì

Sintassi della risposta

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

Elementi di risposta

Se l'operazione riesce, il servizio restituisce una risposta HTTP 200.

I seguenti dati vengono restituiti in formato JSON.

accessKeyId

L'ID della chiave di accesso che identifica le credenziali di sicurezza temporanee.

Vincoli di lunghezza: lunghezza minima di 16. La lunghezza massima è 128 caratteri.

Modello: [\w]*

secretAccessKey

La chiave di accesso segreta che può essere utilizzata per firmare le richieste.

Tipo: stringa

sessionToken

Il token che gli utenti devono passare all'API del servizio per utilizzare le credenziali temporanee.

Tipo: stringa

Regione

La regione a cui ti rivolgi per le chiamate API.

Tipo: CONSTANT - edge

Errori

IllegalArgumentException

La richiesta è stata respinta perché il corpo del documento fornito non era valido. Il messaggio di errore descrive l'errore specifico.

Codice di stato HTTP: 400

AccessDeniedException

L'utente non dispone di credenziali valide basate sull'attuale Identity Provider. Il messaggio di errore descrive il meccanismo di autenticazione.

Codice di stato HTTP: 403

TooManyRequestsException

La richiesta ha raggiunto il limite di tentativi di autenticazione. Il messaggio di errore contiene la quantità di tempo di attesa prima che vengano effettuati nuovi tentativi di autenticazione.

Codice di stato HTTP: 429