Lowongan kerja perangkat HTTP API - AWS IoT Core

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Lowongan kerja perangkat HTTP API

Perangkat dapat berkomunikasi denganAWS IoTPekerjaan menggunakan HTTP Signature Versi 4 pada port 443. Ini adalah metode yang digunakan olehAWSSDK dan CLI. Untuk informasi selengkapnya tentang alat tersebut, lihatAWS CLIReferensi Perintah:iot-jobs-dataatauAWSSDK dan Alat.

Perintah berikut tersedia untuk perangkat yang menjalankan pekerjaan. Untuk informasi tentang penggunaan operasi API dengan protokol MQTT, lihatPekerjaan perangkat operasi MQTT API.

Mendapat daftar semua pekerjaan yang tidak dalam keadaan terminal, untuk hal tertentu.

HTTPS request
GET /things/thingName/jobs

Jawaban:

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

Untuk informasi selengkapnya, lihat GetPendingJobExecutions.

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

cli-input-jsonFormat:

{
"thingName": "string"
}

Untuk informasi selengkapnya, lihat get-pending-job-executions.

Mendapat dan memulai eksekusi pekerjaan tertunda berikutnya untuk suatu hal (dengan statusIN_PROGRESSatauQUEUED).

  • Setiap eksekusi pekerjaan dengan statusIN_PROGRESSdikembalikan terlebih dahulu.

  • Eksekusi pekerjaan dikembalikan dalam urutan di mana mereka diciptakan.

  • Jika eksekusi pekerjaan tertunda berikutnya adalahQUEUED, statusnya berubah menjadiIN_PROGRESSdan rincian status eksekusi pekerjaan ditetapkan seperti yang ditentukan.

  • Jika eksekusi pekerjaan tertunda berikutnya sudahIN_PROGRESS, detail statusnya tidak berubah.

  • Jika tidak ada eksekusi pekerjaan yang tertunda, respons tidak menyertakanexecutionbidang.

  • Opsional, Anda dapat membuat timer langkah dengan menetapkan nilai untukstepTimeoutInMinutesproperti. Jika Anda tidak memperbarui nilai properti ini dengan menjalankanUpdateJobExecution, eksekusi pekerjaan kali keluar ketika timer langkah berakhir.

HTTPS request

Contoh berikut menunjukkan sintaks permintaan:

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

Untuk informasi selengkapnya, lihat StartNextPendingJobExecution.

CLI syntax

Sinopsis:

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-jsonFormat:

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

Untuk informasi selengkapnya, lihat start-next-pending-job-execution.

Mendapat informasi rinci tentang eksekusi pekerjaan.

Anda dapat mengaturjobIdkepada$nextuntuk mengembalikan eksekusi pekerjaan tertunda berikutnya untuk sesuatu. Status eksekusi pekerjaan harusQUEUEDatauIN_PROGRESS.

HTTPS request

Permintaan:

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

Jawaban:

{
"execution" : JobExecution,
}

Untuk informasi selengkapnya, lihat DescribeJobExecution.

CLI syntax

Sinopsis:

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-jsonFormat:

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

Untuk informasi selengkapnya, lihat describe-job-execution.

Memperbarui status eksekusi pekerjaan. Opsional, Anda dapat membuat timer langkah dengan menetapkan nilai untukstepTimeoutInMinutesproperti. Jika Anda tidak memperbarui nilai properti ini dengan menjalankanUpdateJobExecutionsekali lagi, eksekusi pekerjaan kali keluar ketika timer langkah berakhir.

HTTPS request

Permintaan:

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

Untuk informasi selengkapnya, lihat UpdateJobExecution.

CLI syntax

Sinopsis:

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-jsonFormat:

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

Untuk informasi selengkapnya, lihat update-job-execution.