Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
Manajemen pekerjaan dan kontrol API dan tipe data
Perintah berikut tersedia untuk manajemen dan kontrol Job di CLI dan melalui protokol HTTPS.
Untuk menentukanendpoint-url
parameter untuk perintah CLI Anda, jalankan perintah ini.
aws iot describe-endpoint --endpoint-type=iot:Jobs
Perintah ini mengembalikan output berikut.
{ "endpointAddress": "
account-specific-prefix
.jobs.iot.aws-region
.amazonaws.com" }
catatan
Endpoint Lowongan Kerja tidak mendukung ALPNz-amzn-http-ca
.
Manajemen pekerjaan dan tipe data kontrol
Jenis data berikut digunakan oleh manajemen dan kontrol aplikasi untuk berkomunikasi denganAWS IoTPekerjaan.
YangJob
objek berisi rincian tentang pekerjaan. Contoh berikut menunjukkan sintaks:
{ "jobArn": "string", "jobId": "string", "status": "IN_PROGRESS|CANCELED|SUCCEEDED", "forceCanceled": boolean, "targetSelection": "CONTINUOUS|SNAPSHOT", "comment": "string", "targets": ["string"], "description": "string", "createdAt": timestamp, "lastUpdatedAt": timestamp, "completedAt": timestamp, "jobProcessDetails": { "processingTargets": ["string"], "numberOfCanceledThings": long, "numberOfSucceededThings": long, "numberOfFailedThings": long, "numberOfRejectedThings": long, "numberOfQueuedThings": long, "numberOfInProgressThings": long, "numberOfRemovedThings": long, "numberOfTimedOutThings": long }, "presignedUrlConfig": { "expiresInSec": number, "roleArn": "string" }, "jobExecutionsRolloutConfig": { "exponentialRate": { "baseRatePerMinute": integer, "incrementFactor": integer, "rateIncreaseCriteria": { "numberOfNotifiedThings": integer, // Set one or the other "numberOfSucceededThings": integer // of these two values. }, "maximumPerMinute": integer } }, "abortConfig": { "criteriaList": [ { "action": "string", "failureType": "string", "minNumberOfExecutedThings": integer, "thresholdPercentage": integer } ] }, "SchedulingConfig": { "startTime": string "endTime": string "timeZone": string "endTimeBehavior": string }, "timeoutConfig": { "inProgressTimeoutInMinutes": long } }
YangJobSummary
objek berisi ringkasan pekerjaan. Contoh berikut menunjukkan sintaks:
{ "jobArn": "string", "jobId": "string", "status": "IN_PROGRESS|CANCELED|SUCCEEDED|SCHEDULED", "targetSelection": "CONTINUOUS|SNAPSHOT", "thingGroupId": "string", "createdAt": timestamp, "lastUpdatedAt": timestamp, "completedAt": timestamp }
Untuk informasi lebih lanjut, lihat JobSummary
atau job-summary
.
YangJobExecution
objek merupakan pelaksanaan pekerjaan pada perangkat. Contoh berikut menunjukkan sintaks:
catatan
Saat Anda menggunakan operasi API control plane,JobExecution
tipe data tidak mengandungJobDocument
bidang. Untuk mendapatkan informasi ini, Anda dapat menggunakanGetJobDocument
Operasi API atauget-job-document
Perintah CLI.
{ "approximateSecondsBeforeTimedOut": 50, "executionNumber": 1234567890, "forceCanceled": true|false, "jobId": "string", "lastUpdatedAt": timestamp, "queuedAt": timestamp, "startedAt": timestamp, "status": "QUEUED|IN_PROGRESS|FAILED|SUCCEEDED|CANCELED|TIMED_OUT|REJECTED|REMOVED", "forceCanceled": boolean, "statusDetails": { "detailsMap": { "string": "string" ... }, "status": "string" }, "thingArn": "string", "versionNumber": 123 }
Untuk informasi lebih lanjut, lihat JobExecution
atau job-execution
.
YangJobExecutionSummary
objek berisi informasi ringkasan eksekusi pekerjaan. Contoh berikut menunjukkan sintaks:
{ "executionNumber": 1234567890, "queuedAt": timestamp, "lastUpdatedAt": timestamp, "startedAt": timestamp, "status": "QUEUED|IN_PROGRESS|FAILED|SUCCEEDED|CANCELED|TIMED_OUT|REJECTED|REMOVED" }
Untuk informasi lebih lanjut, lihat JobExecutionSummary
atau job-execution-summary
.
YangJobExecutionSummaryForJob
objek berisi ringkasan informasi tentang eksekusi pekerjaan untuk pekerjaan tertentu. Contoh berikut menunjukkan sintaks:
{ "executionSummaries": [ { "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyThing", "jobExecutionSummary": { "status": "IN_PROGRESS", "lastUpdatedAt": 1549395301.389, "queuedAt": 1541526002.609, "executionNumber": 1 } }, ... ] }
Untuk informasi lebih lanjut, lihat JobExecutionSummaryForJob
atau job-execution-summary-for-job
.
YangJobExecutionSummaryForThing
objek berisi ringkasan informasi tentang eksekusi pekerjaan pada hal tertentu. fContoh berikut menunjukkan sintaks:
{ "executionSummaries": [ { "jobExecutionSummary": { "status": "IN_PROGRESS", "lastUpdatedAt": 1549395301.389, "queuedAt": 1541526002.609, "executionNumber": 1 }, "jobId": "MyThingJob" }, ... ] }
Untuk informasi lebih lanjut, lihat JobExecutionSummaryForThing
atau job-execution-summary-for-thing
.
Manajemen pekerjaan dan pengendalian operasi API
Gunakan operasi API atau perintah CLI berikut:
Mengaitkan kelompok dengan pekerjaan berkelanjutan. Kriteria berikut harus dipenuhi:
-
Pekerjaan harus telah dibuat dengan
targetSelection
field set keCONTINUOUS
. -
Status pekerjaan saat ini harus
IN_PROGRESS
. -
Jumlah total target yang terkait dengan pekerjaan tidak boleh melebihi 100.
Membatalkan pekerjaan.
Membatalkan eksekusi pekerjaan di perangkat.
Menciptakan pekerjaan. Anda dapat memberikan dokumen pekerjaan sebagai tautan ke file dalam bucket Amazon S3 (documentSource
parameter), atau dalam tubuh permintaan (document
parameter).
Pekerjaan dapat dibuatberkesinambungandengan mengatur opsionaltargetSelection
parameter keCONTINUOUS
(defaultnya adalahSNAPSHOT
). Pekerjaan berkelanjutan dapat digunakan untuk onboard atau meng-upgrade perangkat saat ditambahkan ke grup karena terus berjalan dan diluncurkan pada hal-hal yang baru ditambahkan. Hal ini dapat terjadi bahkan setelah hal-hal dalam kelompok pada saat pekerjaan itu dibuat telah menyelesaikan pekerjaan.
Pekerjaan dapat memiliki opsionalTimeoutConfig, yang menetapkan nilai timer dalam proses. Timer dalam proses tidak dapat diperbarui dan berlaku untuk semua eksekusi pekerjaan.
Validasi berikut dilakukan pada argumen keCreateJob
API:
-
Yang
targets
argumen harus berupa daftar hal yang valid atau kelompok hal ARN. Semua hal dan kelompok hal harus ada diAkun AWS. -
Yang
documentSource
argumen harus berupa URL Amazon S3 yang valid untuk dokumen pekerjaan. URL Amazon S3 ada dalam bentuk:https://s3.amazonaws.com/
.bucketName
/objectName
-
Dokumen yang disimpan dalam URL yang ditentukan oleh
documentSource
argumen harus berupa dokumen JSON yang dikodekan UTF-8. -
Ukuran dokumen pekerjaan dibatasi hingga 32 KB karena batas ukuran pesan MQTT (128 KB) dan enkripsi.
-
Yang
jobId
harus unik diAkun AWS.
Menghapus pekerjaan dan eksekusi pekerjaan terkait.
Menghapus pekerjaan dapat memakan waktu, tergantung pada jumlah eksekusi pekerjaan yang dibuat untuk pekerjaan dan berbagai faktor lainnya. Sementara pekerjaan sedang dihapus, status pekerjaan ditampilkan sebagai “DELETION_IN_PROGRESS”. Mencoba menghapus atau membatalkan pekerjaan yang statusnya sudah “DELETION_IN_PROGRESS” menghasilkan kesalahan.
Menghapus eksekusi pekerjaan.
Mendapat rincian eksekusi pekerjaan.
Mendapat rincian eksekusi pekerjaan. Status eksekusi pekerjaan harusSUCCEEDED
atauFAILED
.
Mendapat dokumen pekerjaan untuk pekerjaan.
catatan
URL placeholder tidak diganti dengan URL Amazon S3 yang telah ditandatangani sebelumnya dalam dokumen yang dikembalikan. URL presigned dihasilkan hanya bilaAWS IoTLayanan pekerjaan menerima permintaan melalui MQTT.
Mendapat daftar eksekusi pekerjaan untuk pekerjaan.
Mendapat daftar eksekusi pekerjaan untuk sesuatu.
Mendapat daftar pekerjaan diAkun AWS.
Memperbarui bidang yang didukung dari pekerjaan yang ditentukan. Nilai yang diperbarui untuktimeoutConfig
berlaku hanya untuk peluncuran yang baru dalam proses. Saat ini, peluncuran dalam proses terus diluncurkan dengan konfigurasi batas waktu sebelumnya.