View a markdown version of this page

MQTT-API für die Gerätebereitstellung - AWS IoT Core
CreateCertificateFromCsrCreateKeysAndCertificateRegisterThing

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.

MQTT-API für die Gerätebereitstellung

Der Fleet Provisioning-Dienst unterstützt die folgenden MQTT-API-Operationen:

Diese API unterstützt Antwortpuffer im Format Concise Binary Object Representation (CBOR) und JavaScript Object Notation (JSON), je nach Thema. payload-format Der Übersichtlichkeit halber werden die Antwort- und Anforderungsbeispiele in diesem Abschnitt im JSON-Format angezeigt.

payload-format Datentyp des Antwortformats
cbor Concise Binary Object Representation (CBOR)
json JavaScript Objektnotation (JSON)
Wichtig

Bevor Sie ein Anforderungsnachrichtenthema veröffentlichen, abonnieren Sie die Antwortthemen, um die Antwort zu erhalten. Die von dieser API verwendeten Nachrichten verwenden das publish/subscribe MQTT-Protokoll, um eine Anfrage- und Antwortinteraktion bereitzustellen.

Wenn Sie die Antwortthemen nicht abonnieren, bevor Sie eine Anfrage veröffentlichen, erhalten Sie möglicherweise nicht die Ergebnisse dieser Anfrage.

IoT Core Fleet Provisioning gibt die MQTT-API-Ergebnisse für die Gerätebereitstellung über dieselbe MQTT-Verbindung zurück, die für die Veröffentlichung der API-Anfrage verwendet wurde.

CreateCertificateFromCsr

Erstellt ein Zertifikat aus einer Zertifikatsignieranforderung (CSR). AWS IoT stellt Client-Zertifikate bereit, die von der Amazon Root Certificate Authority (CA) signiert sind. Das neue Zertifikat hat den Status PENDING_ACTIVATION. Wenn Sie RegisterThing aufrufen, um ein Objekt mit diesem Zertifikat bereitzustellen, ändert sich der Zertifikatstatus in ACTIVE oder INACTIVE, wie in der Vorlage beschrieben.

Weitere Informationen zum Erstellen eines Client-Zertifikats mit Ihrem Zertifizierungsstellenzertifikat und einer Zertifikatsignierungsanforderung finden Sie unter Erstellen eines Clientzertifikats mit Ihrem CA-Zertifikat.

Anmerkung

Aus Sicherheitsgründen läuft das von CreateCertificateFromCsr ausgegebene certificateOwnershipToken zurückgesendet nach einer Stunde ab. RegisterThing muss aufgerufen werden, bevor certificateOwnershipToken abläuft. Wenn das von erstellte Zertifikat CreateCertificateFromCsr bis zum Ablauf des Tokens nicht aktiviert und an eine Richtlinie oder eine Sache angehängt wurde, wird das Zertifikat gelöscht. Wenn das Token abläuft, kann das Gerät CreateCertificateFromCsr erneut aufrufen, um ein neues Zertifikat zu generieren.

CreateCertificateFromCsr Anfrage

Veröffentlichen Sie eine Nachricht mit dem Thema $aws/certificates/create-from-csr/payload-format.

payload-format

Das Nachrichtennutzlastformat ist cbor oder json.

CreateCertificateFromCsr Nutzlast anfordern

{
    "certificateSigningRequest": "string"
}
certificateSigningRequest

Die CSR im PEM-Format.

CreateCertificateFromCsr Antwort

Abonnieren Sie $aws/certificates/create-from-csr/payload-format/accepted.

payload-format

Das Nachrichtennutzlastformat ist cbor oder json.

CreateCertificateFromCsr Nutzlast der Antwort

{
    "certificateOwnershipToken": "string",
    "certificateId": "string",
    "certificatePem": "string"
}
certificateOwnershipToken

Das Token, um den Besitz des Zertifikats während der Bereitstellung nachzuweisen.

certificateId

Die ID des Zertifikats. Zertifikatsverwaltungsoperationen verwenden nur eine certificateId.

certificatePem

Die Zertifikatdaten im PEM-Format.

CreateCertificateFromCsr Fehler

Um Fehlerantworten zu empfangen, abonnieren Sie $aws/certificates/create-from-csr/payload-format/rejected.

payload-format

Das Nachrichtennutzlastformat ist cbor oder json.

CreateCertificateFromCsr Fehler bei der Nutzlast

{
    "statusCode": int,
    "errorCode": "string",
    "errorMessage": "string"
}
statusCode

Welcher Statuscode gesendet wird

errorCode

Der Fehlercode.

errorMessage

Die Fehlermeldung.

CreateKeysAndCertificate

Erstellt neue Schlüssel und ein Zertifikat. AWS IoT stellt Client-Zertifikate bereit, die von der Amazon Root Certificate Authority (CA) signiert sind. Das neue Zertifikat hat den Status PENDING_ACTIVATION. Wenn Sie RegisterThing aufrufen, um ein Objekt mit diesem Zertifikat bereitzustellen, ändert sich der Zertifikatstatus in ACTIVE oder INACTIVE, wie in der Vorlage beschrieben.

Anmerkung

Aus Sicherheitsgründen läuft das von CreateKeysAndCertificate ausgegebene certificateOwnershipToken zurückgesendet nach einer Stunde ab. RegisterThing muss aufgerufen werden, bevor certificateOwnershipToken abläuft. Wenn das von erstellte Zertifikat CreateKeysAndCertificate bis zum Ablauf des Tokens nicht aktiviert und an eine Richtlinie oder eine Sache angehängt wurde, wird das Zertifikat gelöscht. Wenn das Token abläuft, kann das Gerät CreateKeysAndCertificate erneut aufrufen, um ein neues Zertifikat zu generieren.

CreateKeysAndCertificate Anfrage

Veröffentlichen Sie eine Nachricht unter $aws/certificates/create/payload-format mit einer leeren Nachrichtennutzlast.

payload-format

Das Nachrichtennutzlastformat ist cbor oder json.

CreateKeysAndCertificate Antwort

Abonnieren Sie $aws/certificates/create/payload-format/accepted.

payload-format

Das Nachrichtennutzlastformat ist cbor oder json.

CreateKeysAndCertificate Antwort

{
    "certificateId": "string",
    "certificatePem": "string",
    "privateKey": "string",
    "certificateOwnershipToken": "string"
}
certificateId

Die ID des Zertifikats.

certificatePem

Die Zertifikatdaten im PEM-Format.

privateKey

Der private Schlüssel.

certificateOwnershipToken

Das Token, um den Besitz des Zertifikats während der Bereitstellung nachzuweisen.

CreateKeysAndCertificate Fehler

Um Fehlerantworten zu empfangen, abonnieren Sie $aws/certificates/create/payload-format/rejected.

payload-format

Das Nachrichtennutzlastformat ist cbor oder json.

CreateKeysAndCertificate Fehler bei der Nutzlast

{
    "statusCode": int,
    "errorCode": "string",
    "errorMessage": "string"
}
statusCode

Welcher Statuscode gesendet wird

errorCode

Der Fehlercode.

errorMessage

Die Fehlermeldung.

RegisterThing

Stellt ein Objekt anhand einer vordefinierten Vorlage bereit.

RegisterThing Anfrage

Veröffentlichen Sie eine Nachricht unter $aws/provisioning-templates/templateName/provision/payload-format.

payload-format

Das Nachrichtennutzlastformat ist cbor oder json.

templateName

Der Name der Bereitstellungsvorlage.

RegisterThing Nutzlast anfordern

{
    "certificateOwnershipToken": "string",
    "parameters": {
        "string": "string",
        ...
    }
}
certificateOwnershipToken

Das Token zum Nachweis der Inhaberschaft des Zertifikats. AWS IoT generiert das Token, wenn Sie ein Zertifikat über MQTT erstellen.

parameters

Fakultativ. Key-value Paare vom Gerät, die von den Pre-Provisioning-Hooks zur Auswertung der Registrierungsanforderung verwendet werden.

RegisterThing Antwort

Abonnieren Sie $aws/provisioning-templates/templateName/provision/payload-format/accepted.

payload-format

Das Nachrichtennutzlastformat ist cbor oder json.

templateName

Der Name der Bereitstellungsvorlage.

RegisterThing Nutzlast der Antwort

{
    "deviceConfiguration": {
        "string": "string",
        ...
    },
    "thingName": "string"
}
deviceConfiguration

Die in der Vorlage definierte Gerätekonfiguration.

thingName

Der Name des IoT-Objekts, das während der Bereitstellung erstellt wurde.

RegisterThing Fehlerantwort

Um Fehlerantworten zu empfangen, abonnieren Sie $aws/provisioning-templates/templateName/provision/payload-format/rejected.

payload-format

Das Nachrichtennutzlastformat ist cbor oder json.

templateName

Der Name der Bereitstellungsvorlage.

RegisterThing Nutzlast für die Fehlerantwort

{
    "statusCode": int,
    "errorCode": "string",
    "errorMessage": "string"
}
statusCode

Welcher Statuscode gesendet wird

errorCode

Der Fehlercode.

errorMessage

Die Fehlermeldung.