Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
Nur-Edge-APIs zur Verwendung mit AWS IoT SiteWise Edge-Geräten
Zusätzlich zu den AWS IoT SiteWise APIs, die auf dem Edge verfügbar sind, gibt es auch Edge-spezifische APIs. Diese Edge-spezifischen APIs werden unten beschrieben.
Authentifizieren
Ruft die Anmeldeinformationen vom SiteWise Edge-Gateway ab. Sie müssen lokale Benutzer hinzufügen oder über LDAP oder einen Linux-Benutzerpool eine Verbindung zu Ihrem System herstellen. Weitere Informationen zum Hinzufügen von Benutzern finden Sie unter LDAP -oder Linux-Benutzerpool.
Erforderliche Syntax
POST /authenticate HTTP/1.1 Content-type: application/json { "username": "string", "password": "string", "authMechanism": "string" }
URI-Anforderungsparameter
Die Anforderung verwendet keine URI-Parameter.
Anforderungstext
Die Anforderung akzeptiert die folgenden Daten im JSON-Format.
- username
-
Der Benutzername, der zur Validierung des Anforderungsaufrufs verwendet wird.
Typ: Zeichenfolge
Erforderlich: Ja
- password
-
Das Passwort des Benutzers, der Anmeldeinformationen anfordert.
Typ: Zeichenfolge
Erforderlich: Ja
- authMechanism
-
Die Authentifizierungsmethode zur Validierung dieses Benutzers im Host.
Typ: Zeichenfolge
Zulässige Werte:
ldap
,linux
,winnt
Erforderlich: Ja
Antwortsyntax
HTTP/1.1 200 Content-type: application/json { "accessKeyId": "string", "secretAccessKey": "string", "sessionToken": "string", "region": "edge" }
Antwortelemente
Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.
Die folgenden Daten werden im JSON-Format zurückgegeben.
- accessKeyId
-
Die Zugriffsschlüssel-ID, die die temporären Sicherheitsanmeldeinformationen identifiziert.
Längenbeschränkungen: Mindestlänge von 16. Maximale Länge beträgt 128 Zeichen.
Pattern:
[\w]*
- secretAccessKey
-
Der geheime Zugriffsschlüssel, der zum Signieren von Anforderungen verwendet werden kann.
Typ: Zeichenfolge
- sessionToken
-
Das Token, das Benutzer an die Service-API übergeben müssen, um die temporären Anmeldeinformationen zu verwenden.
Typ: Zeichenfolge
- Region
-
Die Region, die Sie für API-Aufrufe verwenden möchten.
Typ: CONSTANT –
edge
Fehler
- IllegalArgumentException
-
Die Anforderung wurde abgelehnt, da das bereitgestellte Textdokument falsch formatiert war. Die Fehlermeldung beschreibt den spezifischen Fehler.
HTTP Status Code: 400
- AccessDeniedException
-
Der Benutzer verfügt nicht über gültige Anmeldeinformationen, die auf dem aktuellen Identitätsanbieter basieren. Die Fehlermeldung beschreibt den Authentifizierungsmechanismus.
HTTP Status Code: 403
- TooManyRequestsException
-
Die Anforderung hat ihr Limit an Authentifizierungsversuchen erreicht. Die Fehlermeldung enthält die Wartezeit, bis neue Authentifizierungsversuche durchgeführt werden.
HTTP-Statuscode: 429