Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
Pekerjaan perangkat HTTP API
Perangkat dapat berkomunikasi dengan AWS IoT Jobs menggunakan HTTP Signature Versi 4 pada port 443. Ini adalah metode yang digunakan oleh AWS SDK dan CLI. Untuk informasi selengkapnya tentang alat tersebut, lihat AWS CLI Perintah Reference:iot-jobs-data atau AWS
SDK dan Alat.
Perintah berikut tersedia untuk perangkat yang menjalankan pekerjaan. Untuk informasi tentang menggunakan operasi API dengan protokol MQTT, lihatPekerjaan perangkat operasi MQTT API.
Mendapat daftar semua pekerjaan yang tidak dalam status terminal, untuk hal yang ditentukan.
- HTTPS request
GET /things/thingName/jobs
Respons:
{
"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 status IN_PROGRESS atauQUEUED).
-
Setiap eksekusi pekerjaan dengan status IN_PROGRESS dikembalikan terlebih dahulu.
-
Eksekusi pekerjaan dikembalikan dalam urutan pembuatannya.
-
Jika eksekusi pekerjaan tertunda berikutnya adalahQUEUED, statusnya berubah menjadi IN_PROGRESS dan detail status eksekusi pekerjaan ditetapkan seperti yang ditentukan.
-
Jika eksekusi tugas tertunda berikutnya sudah IN_PROGRESS ada, detail statusnya tidak berubah.
-
Jika tidak ada eksekusi pekerjaan yang tertunda, respons tidak menyertakan execution bidang tersebut.
-
Secara opsional, Anda dapat membuat timer langkah dengan mengatur nilai untuk stepTimeoutInMinutes properti. Jika Anda tidak memperbarui nilai properti ini dengan menjalankanUpdateJobExecution, waktu eksekusi pekerjaan habis saat penghitung waktu 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.
Mendapatkan informasi terperinci tentang eksekusi pekerjaan.
Anda dapat mengatur ke jobId $next untuk mengembalikan eksekusi pekerjaan tertunda berikutnya untuk suatu hal. Status eksekusi pekerjaan harus QUEUED atauIN_PROGRESS.
- HTTPS request
Permintaan:
GET /things/thingName/jobs/jobId?executionNumber=executionNumber&includeJobDocument=includeJobDocument
Respons:
{
"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. Secara opsional, Anda dapat membuat timer langkah dengan mengatur nilai untuk stepTimeoutInMinutes properti. Jika Anda tidak memperbarui nilai properti ini dengan menjalankannya UpdateJobExecution lagi, waktu eksekusi pekerjaan habis saat penghitung waktu 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
}
Lihat informasi yang lebih lengkap di update-job-execution.
