View a markdown version of this page

AWS IoT pekerjaan operasi API - AWS IoT Core

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

AWS IoT pekerjaan operasi API

AWS IoT Jobs API dapat digunakan untuk salah satu kategori berikut:

  • Tugas administratif seperti manajemen dan kontrol pekerjaan. Ini adalah pesawat kontrol.

  • Perangkat yang melaksanakan tugas-tugas tersebut. Ini adalah bidang data, yang memungkinkan Anda mengirim dan menerima data.

Manajemen dan kontrol pekerjaan menggunakan API protokol HTTPS. Perangkat dapat menggunakan MQTT atau API protokol HTTPS. API bidang kontrol dirancang untuk volume panggilan rendah yang khas saat membuat dan melacak pekerjaan. Biasanya membuka koneksi untuk permintaan tunggal, dan kemudian menutup koneksi setelah respons diterima. Bidang data HTTPS dan MQTT API memungkinkan polling panjang. Operasi API ini dirancang untuk lalu lintas dalam jumlah besar yang dapat ditingkatkan ke jutaan perangkat.

Setiap AWS IoT Jobs HTTPS API memiliki perintah yang sesuai yang memungkinkan Anda memanggil API dari AWS Command Line Interface (AWS CLI). Perintahnya adalah huruf kecil, dengan tanda hubung di antara kata-kata yang membentuk nama API. Misalnya, Anda dapat memanggil CreateJob API pada CLI dengan mengetik:

aws iot create-job ...

Jika terjadi kesalahan selama operasi, Anda mendapatkan respons kesalahan yang berisi informasi tentang kesalahan.

Berisi informasi tentang kesalahan yang terjadi selama operasi layanan AWS IoT Jobs.

Contoh berikut menunjukkan sintaks operasi ini:

{
    "code": "ErrorCode",
    "message": "string",
    "clientToken": "string",
    "timestamp": timestamp,
    "executionState": JobExecutionState
}

Berikut ini adalah deskripsi tentang iniErrorResponse:

code

ErrorCode dapat diatur ke:

InvalidTopic

Permintaan dikirim ke topik di namespace AWS IoT Jobs yang tidak dipetakan ke operasi API apa pun.

InvalidJson

Isi permintaan tidak dapat ditafsirkan sebagai UTF-8-encoded JSON yang valid.

InvalidRequest

Isi permintaan tidak valid. Misalnya, kode ini dikembalikan ketika UpdateJobExecution permintaan berisi detail status yang tidak valid. Pesan berisi detail tentang kesalahan.

InvalidStateTransition

Pembaruan mencoba mengubah eksekusi pekerjaan ke status yang tidak valid karena status eksekusi pekerjaan saat ini. Misalnya, upaya untuk mengubah permintaan dalam status SUCCEEDED menjadi state IN_PROGRESS. Dalam hal ini, isi pesan kesalahan juga berisi executionState bidang.

ResourceNotFound

Yang JobExecution ditentukan oleh topik permintaan tidak ada.

VersionMismatch

Versi yang diharapkan yang ditentukan dalam permintaan tidak cocok dengan versi eksekusi pekerjaan di layanan AWS IoT Jobs. Dalam hal ini, isi pesan kesalahan juga berisi executionState bidang.

InternalError

Ada kesalahan internal selama pemrosesan permintaan.

RequestThrottled

Permintaan itu dibatasi.

TerminalStateReached

Terjadi ketika perintah untuk menggambarkan pekerjaan dilakukan pada pekerjaan yang berada dalam status terminal.

message

String pesan kesalahan.

clientToken

String arbitrer yang digunakan untuk menghubungkan permintaan dengan balasannya.

timestamp

Waktu, dalam hitungan detik sejak zaman.

executionState

Sebuah objek JobExecutionState. Bidang ini disertakan hanya jika code bidang memiliki nilai InvalidStateTransition atauVersionMismatch. Ini membuatnya tidak perlu dalam kasus ini untuk melakukan DescribeJobExecution permintaan terpisah untuk mendapatkan data status eksekusi pekerjaan saat ini.

Berikut ini mencantumkan operasi Jobs API dan tipe data.