Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
# Pekerjaan perangkat operasi MQTT API
Anda dapat mengeluarkan perintah perangkat pekerjaan dengan menerbitkan pesan MQTT ke [topik Cadangan yang digunakan untuk](reserved-topics.md#reserved-topics-job) perintah Pekerjaan.
Klien sisi perangkat Anda harus berlangganan topik pesan respons dari perintah ini. Jika Anda menggunakan Klien AWS IoT Perangkat, perangkat Anda akan secara otomatis berlangganan topik respons. Ini berarti bahwa broker pesan akan mempublikasikan topik pesan respons kepada klien yang menerbitkan pesan perintah, apakah klien Anda telah berlangganan topik pesan respons atau tidak. Pesan respons ini tidak melewati broker pesan dan tidak dapat berlangganan oleh klien atau aturan lain.
Saat berlangganan topik pekerjaan dan `jobExecution` acara untuk solusi pemantauan armada Anda, pertama-tama aktifkan [acara pelaksanaan pekerjaan dan pekerjaan untuk menerima acara](iot-events.md) apa pun di sisi cloud. Pesan kemajuan pekerjaan yang diproses melalui broker pesan dan dapat digunakan oleh AWS IoT aturan dipublikasikan sebagai[Peristiwa tugas](events-jobs.md). Karena broker pesan menerbitkan pesan respons, bahkan tanpa berlangganan eksplisit, klien Anda harus dikonfigurasi untuk menerima dan mengidentifikasi pesan yang diterimanya. Klien Anda juga harus mengonfirmasi bahwa topik pesan masuk berlaku untuk nama barang klien sebelum klien bertindak atas pesan tersebut. *thingName*
**catatan**
Pesan yang AWS IoT dikirim sebagai respons terhadap pesan perintah MQTT Jobs API dibebankan ke akun Anda, terlepas dari apakah Anda berlangganan pesan tersebut secara eksplisit atau tidak.
Berikut ini menunjukkan operasi MQTT API dan sintaks permintaan dan responsnya. Semua operasi MQTT API memiliki parameter berikut:
clientToken
Token klien opsional yang digunakan untuk menghubungkan permintaan dan tanggapan. Masukkan nilai arbitrer di sini dan itu tercermin dalam respons.
`timestamp`
Waktu dalam hitungan detik sejak zaman, ketika pesan dikirim.
## GetPendingJobExecutions
Mendapat daftar semua pekerjaan yang tidak dalam status terminal, untuk hal tertentu.
Untuk menjalankan API ini, terbitkan pesan di`$aws/things/thingName/jobs/get`.
Minta muatan:
```
{ "clientToken": "string" }
```
Broker pesan akan mempublikasikan `$aws/things/thingName/jobs/get/accepted` dan `$aws/things/thingName/jobs/get/rejected` bahkan tanpa berlangganan khusus untuk mereka. Namun, agar klien Anda menerima pesan, itu harus mendengarkannya. Untuk informasi selengkapnya, lihat [catatan tentang pesan API Pekerjaan](#jobs-mqtt-note).
Payload respons:
```
{
"inProgressJobs" : [ JobExecutionSummary ... ],
"queuedJobs" : [ JobExecutionSummary ... ],
"timestamp" : 1489096425069,
"clientToken" : "client-001"
}
```
Dimana `inProgressJobs` dan `queuedJobs` mengembalikan daftar [JobExecutionSummary](jobs-mqtt-https-api.md#jobs-mqtt-job-execution-summary) objek yang memiliki status `IN_PROGRESS` atau`QUEUED`.
## StartNextPendingJobExecution
Mendapat dan memulai eksekusi pekerjaan tertunda berikutnya untuk suatu hal (status `IN_PROGRESS` atau`QUEUED`).
+ Setiap eksekusi pekerjaan dengan status `IN_PROGRESS` dikembalikan terlebih dahulu.
+ Eksekusi Job dikembalikan sesuai urutan antrian. Ketika sesuatu ditambahkan atau dihapus dari kelompok sasaran untuk pekerjaan Anda, konfirmasikan urutan peluncuran eksekusi pekerjaan baru dibandingkan dengan eksekusi pekerjaan yang ada.
+ Jika eksekusi pekerjaan tertunda berikutnya`QUEUED`, statusnya berubah menjadi `IN_PROGRESS` dan rincian status eksekusi pekerjaan ditetapkan seperti yang ditentukan.
+ Jika eksekusi pekerjaan tertunda berikutnya sudah`IN_PROGRESS`, detail statusnya tidak berubah.
+ Jika tidak ada eksekusi pekerjaan yang tertunda, respons tidak menyertakan `execution` bidang.
+ Secara opsional, Anda dapat membuat pengatur waktu langkah dengan menetapkan nilai untuk `stepTimeoutInMinutes` properti. Jika Anda tidak memperbarui nilai properti ini dengan menjalankan`UpdateJobExecution`, eksekusi pekerjaan akan habis saat pengatur waktu langkah kedaluwarsa.
Untuk menjalankan API ini, terbitkan pesan di`$aws/things/thingName/jobs/start-next`.
Minta muatan:
```
{
"statusDetails": {
"string": "job-execution-state"
...
},
"stepTimeoutInMinutes": long,
"clientToken": "string"
}
```
`statusDetails`
Kumpulan pasangan nama-nilai yang menggambarkan status eksekusi pekerjaan. Jika tidak ditentukan, `statusDetails` tidak berubah.
`stepTimeOutInMinutes`
Menentukan jumlah waktu perangkat ini harus menyelesaikan pelaksanaan pekerjaan ini. Jika status eksekusi pekerjaan tidak disetel ke status terminal sebelum pengatur waktu ini kedaluwarsa, atau sebelum pengatur waktu disetel ulang, (dengan memanggil`UpdateJobExecution`, menyetel status ke `IN_PROGRESS` dan menentukan nilai batas waktu baru di bidang`stepTimeoutInMinutes`) status eksekusi pekerjaan disetel ke. `TIMED_OUT` Menyetel batas waktu ini tidak berpengaruh pada batas waktu eksekusi pekerjaan yang mungkin telah ditentukan saat pekerjaan dibuat (`CreateJob`menggunakan `timeoutConfig` bidang).
Nilai yang valid untuk parameter ini berkisar dari 1 hingga 10080 (1 menit hingga 7 hari). Nilai -1 juga valid dan akan membatalkan pengatur waktu langkah saat ini (dibuat oleh penggunaan sebelumnya UpdateJobExecutionRequest).
Broker pesan akan mempublikasikan `$aws/things/thingName/jobs/start-next/accepted` dan `$aws/things/thingName/jobs/start-next/rejected` bahkan tanpa berlangganan khusus untuk mereka. Namun, agar klien Anda menerima pesan, itu harus mendengarkannya. Untuk informasi selengkapnya, lihat [catatan tentang pesan API Pekerjaan](#jobs-mqtt-note).
Payload respons:
```
{
"execution" : JobExecutionData,
"timestamp" : timestamp,
"clientToken" : "string"
}
```
`execution`Dimana sebuah [JobExecution](jobs-mqtt-https-api.md#jobs-mqtt-job-execution-data) objek. Contoh:
```
{
"execution" : {
"jobId" : "022",
"thingName" : "MyThing",
"jobDocument" : "< contents of job document >",
"status" : "IN_PROGRESS",
"queuedAt" : 1489096123309,
"lastUpdatedAt" : 1489096123309,
"versionNumber" : 1,
"executionNumber" : 1234567890
},
"clientToken" : "client-1",
"timestamp" : 1489088524284,
}
```
## DescribeJobExecution
Mendapat informasi rinci tentang eksekusi pekerjaan.
Anda dapat mengatur `jobId` to `$next` untuk mengembalikan eksekusi pekerjaan tertunda berikutnya untuk suatu hal (dengan status `IN_PROGRESS` atau`QUEUED`).
Untuk menjalankan API ini, terbitkan pesan di`$aws/things/thingName/jobs/jobId/get`.
Minta muatan:
```
{
"jobId" : "022",
"thingName" : "MyThing",
"executionNumber": long,
"includeJobDocument": boolean,
"clientToken": "string"
}
```
`thingName`
Nama benda yang terkait dengan perangkat.
`jobId`
Pengidentifikasi unik yang ditetapkan untuk pekerjaan ini saat dibuat.
Atau gunakan `$next` untuk mengembalikan eksekusi pekerjaan tertunda berikutnya untuk suatu hal (dengan status `IN_PROGRESS` atau`QUEUED`). Dalam hal ini, setiap eksekusi pekerjaan dengan status `IN_PROGRESS` dikembalikan terlebih dahulu. Eksekusi Job dikembalikan dalam urutan di mana mereka diciptakan.
`executionNumber`
(Opsional) Nomor yang mengidentifikasi eksekusi pekerjaan pada perangkat. Jika tidak ditentukan, eksekusi pekerjaan terbaru dikembalikan.
`includeJobDocument`
(Opsional) Kecuali diatur ke`false`, respons berisi dokumen pekerjaan. Nilai default-nya `true`.
Broker pesan akan mempublikasikan `$aws/things/thingName/jobs/jobId/get/accepted` dan `$aws/things/thingName/jobs/jobId/get/rejected` bahkan tanpa berlangganan khusus untuk mereka. Namun, agar klien Anda menerima pesan, itu harus mendengarkannya. Untuk informasi selengkapnya, lihat [catatan tentang pesan API Pekerjaan](#jobs-mqtt-note).
Payload respons:
```
{
"execution" : JobExecutionData,
"timestamp": "timestamp",
"clientToken": "string"
}
```
`execution`Dimana sebuah [JobExecution](jobs-mqtt-https-api.md#jobs-mqtt-job-execution-data) objek.
## UpdateJobExecution
Memperbarui status eksekusi pekerjaan. Anda dapat secara opsional membuat pengatur waktu langkah dengan menetapkan nilai untuk `stepTimeoutInMinutes` properti. Jika Anda tidak memperbarui nilai properti ini dengan menjalankan `UpdateJobExecution` lagi, eksekusi pekerjaan akan habis saat pengatur waktu langkah kedaluwarsa.
Untuk menjalankan API ini, terbitkan pesan di`$aws/things/thingName/jobs/jobId/update`.
Minta muatan:
```
{
"status": "job-execution-state",
"statusDetails": {
"string": "string"
...
},
"expectedVersion": "number",
"executionNumber": long,
"includeJobExecutionState": boolean,
"includeJobDocument": boolean,
"stepTimeoutInMinutes": long,
"clientToken": "string"
}
```
`status`
Status baru untuk pelaksanaan pekerjaan (`IN_PROGRESS`,, `FAILED``SUCCEEDED`, atau`REJECTED`). Ini harus ditentukan pada setiap pembaruan.
`statusDetails`
Kumpulan pasangan nama-nilai yang menggambarkan status eksekusi pekerjaan. Jika tidak ditentukan, `statusDetails` tidak berubah.
`expectedVersion`
Versi eksekusi pekerjaan saat ini yang diharapkan. Setiap kali Anda memperbarui eksekusi pekerjaan, versinya bertambah. Jika versi eksekusi pekerjaan yang disimpan dalam layanan AWS IoT Jobs tidak cocok, pembaruan ditolak dengan `VersionMismatch` kesalahan. Sebuah [ErrorResponse](jobs-api.md#jobs-mqtt-error-response) yang berisi data status eksekusi pekerjaan saat ini juga dikembalikan. (Ini membuatnya tidak perlu melakukan `DescribeJobExecution` permintaan terpisah untuk mendapatkan data status eksekusi pekerjaan.)
`executionNumber`
(Opsional) Nomor yang mengidentifikasi eksekusi pekerjaan pada perangkat. Jika tidak ditentukan, eksekusi pekerjaan terbaru digunakan.
`includeJobExecutionState`
(Opsional) Bila disertakan dan diatur ke`true`, respon berisi `JobExecutionState` bidang. Nilai default-nya `false`.
`includeJobDocument`
(Opsional) Bila disertakan dan diatur ke`true`, respon berisi`JobDocument`. Nilai default-nya `false`.
`stepTimeoutInMinutes`
Menentukan jumlah waktu perangkat ini harus menyelesaikan pelaksanaan pekerjaan ini. Jika status eksekusi pekerjaan tidak disetel ke status terminal sebelum pengatur waktu ini kedaluwarsa, atau sebelum pengatur waktu disetel ulang, status eksekusi pekerjaan disetel ke`TIMED_OUT`. Menyetel atau mengatur ulang batas waktu ini tidak berpengaruh pada batas waktu pelaksanaan pekerjaan yang mungkin telah ditentukan saat pekerjaan dibuat.
Broker pesan akan mempublikasikan `$aws/things/thingName/jobs/jobId/update/accepted` dan `$aws/things/thingName/jobs/jobId/update/rejected` bahkan tanpa berlangganan khusus untuk mereka. Namun, agar klien Anda menerima pesan, itu harus mendengarkannya. Untuk informasi selengkapnya, lihat [catatan tentang pesan API Pekerjaan](#jobs-mqtt-note).
Payload respons:
```
{
"executionState": JobExecutionState,
"jobDocument": "string",
"timestamp": timestamp,
"clientToken": "string"
}
```
`executionState`
Sebuah objek [JobExecutionState](jobs-mqtt-https-api.md#jobs-mqtt-job-execution-state).
`jobDocument`
Objek [dokumen pekerjaan](key-concepts-jobs.md).
Dalam tanggapan MQTT, `jobDocument` bidang adalah objek JSON. Dalam tanggapan HTTP, ini adalah representasi string dari objek JSON.
`timestamp`
Waktu dalam hitungan detik sejak zaman, ketika pesan dikirim.
`clientToken`
Token klien yang digunakan untuk mengkorelasikan permintaan dan tanggapan.
Saat Anda menggunakan protokol MQTT, Anda juga dapat melakukan pembaruan berikut:
## JobExecutionsChanged
Dikirim setiap kali eksekusi pekerjaan ditambahkan atau dihapus dari daftar eksekusi pekerjaan yang tertunda untuk suatu hal.
Gunakan topik:
`$aws/things/thingName/jobs/notify`
Muatan pesan:
```
{
"jobs" : {
"JobExecutionState": [ [https://docs.aws.amazon.com/iot/latest/apireference/API_JobExecutionSummary.html](https://docs.aws.amazon.com/iot/latest/apireference/API_JobExecutionSummary.html) ... ]
},
"timestamp": timestamp
}
```
## NextJobExecutionChanged
Dikirim setiap kali ada perubahan eksekusi pekerjaan berikutnya dalam daftar eksekusi pekerjaan yang tertunda untuk suatu hal, seperti yang didefinisikan untuk [https://docs.aws.amazon.com/iot/latest/apireference/API_DescribeJobExecution.html](https://docs.aws.amazon.com/iot/latest/apireference/API_DescribeJobExecution.html)dengan `jobId``$next`. Pesan ini tidak dikirim ketika rincian eksekusi pekerjaan berikutnya berubah, hanya ketika pekerjaan berikutnya yang akan dikembalikan oleh `DescribeJobExecution` with `jobId` `$next` telah berubah. Pertimbangkan eksekusi pekerjaan J1 dan J2 dengan status. `QUEUED` J1 berikutnya dalam daftar eksekusi pekerjaan yang tertunda. Jika status J2 diubah menjadi `IN_PROGRESS` sementara status J1 tetap tidak berubah, maka pemberitahuan ini dikirim dan berisi rincian J2.
Gunakan topik:
`$aws/things/thingName/jobs/notify-next`
Muatan pesan:
```
{
"execution" : [https://docs.aws.amazon.com/iot/latest/apireference/API_JobExecution.html](https://docs.aws.amazon.com/iot/latest/apireference/API_JobExecution.html),
"timestamp": timestamp,
}
```