HTTP-API für Jobs-Geräte - AWS IoT Core

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.

HTTP-API für Jobs-Geräte

Geräte können kommunizieren mitAWS IoTJobs, die HTTP-Signatur Version 4 auf Port 443 verwenden. Dies ist die Methode, die von derAWSSDKs und CLI. Weitere Informationen zu diesen Tools finden Sie unterAWS CLIBefehlsreferenz:iot-jobs-dataoderAWSSDKs und Tools.

Die folgenden Befehle sind für Geräte verfügbar, die die Jobs ausführen. Hinweise zur Verwendung von API-Operationen mit dem MQTT-Protokoll finden Sie unterMQTT-API-Operationen für Jobs und Geräte.

Ruft die Liste aller Jobs ab, die sich nicht im Endzustand befinden, für eine bestimmte Sache.

HTTPS request
GET /things/thingName/jobs

Antwort:

{
"inProgressJobs" : [ JobExecutionSummary ... ], 
"queuedJobs" : [ JobExecutionSummary ... ]
}

Weitere Informationen finden Sie unter GetPendingJobExecutions.

CLI syntax
aws iot-jobs-data get-pending-job-executions \
--thing-name <value>  \
[--cli-input-json <value>] \
[--generate-cli-skeleton]

cli-input-json format:

{
"thingName": "string"
}

Weitere Informationen finden Sie unter get-pending-job-executions.

Ruft die nächste ausstehende Auftragsausführung für eine Sache ab und startet sie (mit einem Status vonIN_PROGRESSoderQUEUED).

  • Alle Auftragsausführungen mit StatusIN_PROGRESSwerden zuerst zurückgegeben.

  • Auftragsausführungen werden in der Reihenfolge zurückgegeben, in der sie erstellt wurden.

  • Wenn die nächste ausstehende AuftragsausführungQUEUED, sein Status ändert sich zuIN_PROGRESSund die Statusdetails der Auftragsausführung werden wie angegeben festgelegt.

  • Wenn die nächste ausstehende Auftragsausführung bereits erfolgtIN_PROGRESS, seine Statusdetails ändern sich nicht.

  • Wenn keine Auftragsausführung aussteht, enthält die Antwort nicht dieexecutionFeld.

  • Optional können Sie einen Schritttimer erstellen, indem Sie einen Wert für denstepTimeoutInMinutesEigentum. Falls Sie den Wert dieser Eigenschaft nicht aktualisieren, indem Sie UpdateJobExecution ausführen, läuft die Auftragsausführung ab, wenn der Schritt-Timer abläuft.

HTTPS request

Das folgende Beispiel zeigt die Anforderungssyntax:

PUT /things/thingName/jobs/$next
{
"statusDetails": { 
    "string": "string" 
    ... 
},
"stepTimeoutInMinutes": long
}

Weitere Informationen finden Sie unter StartNextPendingJobExecution.

CLI syntax

Syntax:

aws iot-jobs-data  start-next-pending-job-execution \
--thing-name <value> \
{--step-timeout-in-minutes <value>] \
[--status-details <value>]  \
[--cli-input-json <value>] \
[--generate-cli-skeleton]

cli-input-json format:

{
"thingName": "string",
"statusDetails": {
"string": "string"
},
"stepTimeoutInMinutes": long
}

Weitere Informationen finden Sie unter start-next-pending-job-execution.

Ruft detaillierte Informationen zu einer Auftragsausführung ab.

Sie können das einstellenjobIdzu$nextum die nächste ausstehende Auftragsausführung für eine Sache zurückzugeben. Der Ausführungsstatus des Auftrags muss QUEUED oder IN_PROGRESS sein.

HTTPS request

Anfrage:

GET /things/thingName/jobs/jobId?executionNumber=executionNumber&includeJobDocument=includeJobDocument

Antwort:

{
"execution" : JobExecution,
}

Weitere Informationen finden Sie unter DescribeJobExecution.

CLI syntax

Syntax:

aws iot-jobs-data  describe-job-execution \
--job-id <value> \
--thing-name <value> \
[--include-job-document | --no-include-job-document] \
[--execution-number <value>]  \
[--cli-input-json <value>] \
[--generate-cli-skeleton]

cli-input-json format:

{
"jobId": "string",
"thingName": "string",
"includeJobDocument": boolean,
"executionNumber": long
}

Weitere Informationen finden Sie unter describe-job-execution.

Aktualisiert den Status einer Auftragsausführung. Optional können Sie einen Schritttimer erstellen, indem Sie einen Wert für denstepTimeoutInMinutesEigentum. Falls Sie den Wert dieser Eigenschaft nicht aktualisieren, indem Sie UpdateJobExecution erneut ausführen, läuft die Auftragsausführung ab, wenn der Schritt-Timer abläuft.

HTTPS request

Anfrage:

POST /things/thingName/jobs/jobId
{
"status": "job-execution-state",
"statusDetails": { 
    "string": "string"
    ...
},
"expectedVersion": "number",
"includeJobExecutionState": boolean,
"includeJobDocument": boolean,
"stepTimeoutInMinutes": long,
"executionNumber": long 
}

Weitere Informationen finden Sie unter UpdateJobExecution.

CLI syntax

Syntax:

aws iot-jobs-data  update-job-execution \
--job-id <value> \
--thing-name <value> \
--status <value> \
[--status-details <value>] \
[--expected-version <value>] \
[--include-job-execution-state | --no-include-job-execution-state] \
[--include-job-document | --no-include-job-document] \
[--execution-number <value>]  \
[--cli-input-json <value>] \
[--step-timeout-in-minutes <value>] \
[--generate-cli-skeleton]

cli-input-json format:

{
"jobId": "string",
"thingName": "string",
"status": "string",
"statusDetails": {
"string": "string"
},
"stepTimeoutInMinutes": number,
"expectedVersion": long,
"includeJobExecutionState": boolean,
"includeJobDocument": boolean,
"executionNumber": long
}

Weitere Informationen finden Sie unter update-job-execution.